Public Member Functions | Protected Member Functions | Protected Attributes

oxShopControl Class Reference

Inheritance diagram for oxShopControl:
Collaboration diagram for oxShopControl:

List of all members.

Public Member Functions

 start ($sClass=null, $sFunction=null, $aParams=null, $aViewsChain=null)
 getTotalTime ()

Protected Member Functions

 _setDefaultExceptionHandler ()
 _log ($sClass, $sFnc)
 _startMonitor ()
 _stopMonitor ($blIsCache=false, $blIsCached=false, $sViewID=null, $aViewData=array())
 _executeMaintenanceTasks ()
 _process ($sClass, $sFunction, $aParams=null, $aViewsChain=null)
 _initializeViewObject ($sClass, $sFunction, $aParams=null, $aViewsChain=null)
 _canExecuteFunction ($oClass, $sFunction)
 _getFormattedErrors ($sControllerName)
 _render ($oViewObject)
 _getOutputManager ()
 _getErrors ($sCurrentControllerName)
 _runOnce ()
 _isDebugMode ()
 _handleSystemException ($oEx)
 _handleCookieException ($oEx)
 _handleAccessRightsException ($oEx)
 _handleDbConnectionException ($oEx)
 _handleBaseException ($oEx)
 _getControllerToLoad ($sClass=null)

Protected Attributes

 $_blHandlerSet = null
 $_blMainTasksExecuted = null
 $_dTimeStart = null
 $_dTimeEnd = null
 $_aErrors = null
 $_aAllErrors = null
 $_aControllerErrors = null
 $_oOutput = null
 $_oCache = null

Detailed Description

Main shop actions controller. Processes user actions, logs them (if needed), controlls output, redirects according to processed methods logic. This class is initalized from index.php

Definition at line 8 of file oxshopcontrol.php.

Member Function Documentation

oxShopControl._canExecuteFunction ( $  oClass,
$  sFunction 
) [protected]

Check if method can be executed.

Parameters:
object $oClass object to check if its method can be executed.
string $sFunction method to check if it can be executed.
Returns:
bool

Definition at line 396 of file oxshopcontrol.php.

oxShopControl._executeMaintenanceTasks (  )  [protected]

Executes regular maintenance functions..

Returns:
null

Definition at line 265 of file oxshopcontrol.php.

oxShopControl._getControllerToLoad ( $  sClass = null  )  [protected]

Returns controller class which should be loaded.

Parameters:
string $sClass
Returns:
string

Definition at line 685 of file oxshopcontrol.php.

oxShopControl._getErrors ( $  sCurrentControllerName  )  [protected]

return page errors array

Parameters:
string $sCurrentControllerName a class name
Returns:
array

Definition at line 509 of file oxshopcontrol.php.

oxShopControl._getFormattedErrors ( $  sControllerName  )  [protected]

format error messages from _getErrors and return as array

Parameters:
string $sControllerName a class name
Returns:
array

Definition at line 417 of file oxshopcontrol.php.

oxShopControl._getOutputManager (  )  [protected]

return output handler

Returns:
oxOutput

Definition at line 494 of file oxshopcontrol.php.

oxShopControl._handleAccessRightsException ( $  oEx  )  [protected]

R&R handling -> redirect to error msg, also, can call _process again, specifying error handler view class.

Parameters:
$oEx 

Definition at line 644 of file oxshopcontrol.php.

oxShopControl._handleBaseException ( $  oEx  )  [protected]

Catching other not cought exceptions.

Parameters:
oxException $oEx

Definition at line 669 of file oxshopcontrol.php.

oxShopControl._handleCookieException ( $  oEx  )  [protected]

Redirect to start page, in debug mode shows error message.

Parameters:
$oEx 

Definition at line 631 of file oxshopcontrol.php.

oxShopControl._handleDbConnectionException ( $  oEx  )  [protected]

Shows exception message if debug mode is enabled, redirects otherwise.

Parameters:
oxConnectionException $oEx message to show on exit

Definition at line 654 of file oxshopcontrol.php.

oxShopControl._handleSystemException ( $  oEx  )  [protected]

Shows exceptionError page. possible reason: class does not exist etc. --> just redirect to start page.

Parameters:
$oEx 

Definition at line 611 of file oxshopcontrol.php.

oxShopControl._initializeViewObject ( $  sClass,
$  sFunction,
$  aParams = null,
$  aViewsChain = null 
) [protected]

initialize and return view object

Parameters:
string $sClass view name
string $sFunction function name
array $aParams parameters array
array $aViewsChain array of views names that should be initialized also
Returns:
oxView

Reimplemented in oxWidgetControl.

Definition at line 368 of file oxshopcontrol.php.

oxShopControl._isDebugMode (  )  [protected]

Checks if shop is in debug mode

Returns:
bool

Definition at line 595 of file oxshopcontrol.php.

oxShopControl._log ( $  sClass,
$  sFnc 
) [protected]

Logs user performed actions to DB. Skips action logging if it's search engine.

Parameters:
string $sClass Name of class
string $sFnc Name of executed class method
Returns:
null

Definition at line 140 of file oxshopcontrol.php.

oxShopControl._process ( $  sClass,
$  sFunction,
$  aParams = null,
$  aViewsChain = null 
) [protected]

Initiates object (object.init()), executes passed function (oxShopControl.executeFunction(), if method returns some string - will redirect page and will call another function according to returned parameters), renders object (object.render()). Performs output processing oxOutput.ProcessViewArray(). Passes template variables to template engine witch generates output. Output is additionally processed (oxOutput.Process()), fixed links according search engines optimization rules (configurable in Admin area). Finally echoes the output.

Parameters:
string $sClass Name of class
string $sFunction Name of function
array $aParams Parameters array
array $aViewsChain Array of views names that should be initialized also
Returns:
null

Definition at line 293 of file oxshopcontrol.php.

oxShopControl._render ( $  oViewObject  )  [protected]

render oxView object

Parameters:
oxView $oViewObject view object to render
Returns:
string

Definition at line 439 of file oxshopcontrol.php.

oxShopControl._runOnce (  )  [protected]

This function is only executed one time here we perform checks if we only need once per session

Returns:
null

Reimplemented in oxWidgetControl.

Definition at line 541 of file oxshopcontrol.php.

oxShopControl._setDefaultExceptionHandler (  )  [protected]

Sets default exception handler. Ideally all exceptions should be handled with try catch and default exception should never be reached.

Returns:
null;

Definition at line 123 of file oxshopcontrol.php.

oxShopControl._startMonitor (  )  [protected]

Starts resource monitor

Returns:
null

Definition at line 174 of file oxshopcontrol.php.

oxShopControl._stopMonitor ( $  blIsCache = false,
$  blIsCached = false,
$  sViewID = null,
$  aViewData = array() 
) [protected]

Stops resource monitor, summarizes and outputs values

Parameters:
bool $blIsCache Is content cache
bool $blIsCached Is content cached
bool $sViewID View ID
array $aViewData View data
Returns:
null

Definition at line 191 of file oxshopcontrol.php.

oxShopControl.getTotalTime (  ) 

Returns the difference between stored profiler end time and start time. Works only after _stopMonitor() is called, otherwise returns 0.

Returns:
double

Definition at line 251 of file oxshopcontrol.php.

oxShopControl.start ( $  sClass = null,
$  sFunction = null,
$  aParams = null,
$  aViewsChain = null 
)

Main shop manager, that sets shop status, executes configuration methods. Executes oxShopControl._runOnce(), if needed sets default class (according to admin or regular activities). Additionaly its possible to pass class name, function name and parameters array to view, which will be executed.

Session variables: actshop

Parameters:
string $sClass Class name
string $sFunction Funtion name
array $aParams Parameters array
array $aViewsChain Array of views names that should be initialized also
Returns:
null

Reimplemented in oxWidgetControl.

Definition at line 94 of file oxshopcontrol.php.

Member Data Documentation

oxShopControl.$_aAllErrors = null [protected]

Definition at line 55 of file oxshopcontrol.php.

oxShopControl.$_aControllerErrors = null [protected]

Definition at line 64 of file oxshopcontrol.php.

oxShopControl.$_aErrors = null [protected]

Definition at line 46 of file oxshopcontrol.php.

oxShopControl.$_blHandlerSet = null [protected]

Reimplemented in oxWidgetControl.

Definition at line 16 of file oxshopcontrol.php.

oxShopControl.$_blMainTasksExecuted = null [protected]

Reimplemented in oxWidgetControl.

Definition at line 23 of file oxshopcontrol.php.

oxShopControl.$_dTimeEnd = null [protected]

Definition at line 37 of file oxshopcontrol.php.

oxShopControl.$_dTimeStart = null [protected]

Definition at line 30 of file oxshopcontrol.php.

oxShopControl.$_oCache = null [protected]

Definition at line 76 of file oxshopcontrol.php.

oxShopControl.$_oOutput = null [protected]

Definition at line 74 of file oxshopcontrol.php.

The documentation for this class was generated from the following file:
Generated by  doxygen 1.7.1