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 ()
 _initializeViewObject ($sClass, $sFunction, $aParams=null, $aViewsChain=null)
 _canExecuteFunction ($oClass, $sFunction)
 _getFormattedErrors ($sControllerName)
 _render ($oViewObject)
 _getOutputManager ()
 _getErrors ($sCurrentControllerName)
 _runOnce ()
 _getErrorReportingLevel ()
 _isDebugMode ()
 _handleSystemException ($oEx)
 _handleCookieException ($oEx)
 _handleAccessRightsException ($oEx)
 _handleDbConnectionException ($oEx)
 _handleBaseException ($oEx)
 _getStartController ()
 _getFrontendStartController ()
 _getFrontendMallStartController ()

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 400 of file oxshopcontrol.php.

oxShopControl._executeMaintenanceTasks (  )  [protected]

Executes regular maintenance functions..

Returns:
null

Definition at line 267 of file oxshopcontrol.php.

oxShopControl._getErrorReportingLevel (  )  [protected]

Returns error reporting level. Returns disabled error logging if server is misconfigured #2015 E_NONE replaced with 0.

Returns:
int

Definition at line 580 of file oxshopcontrol.php.

oxShopControl._getErrors ( sCurrentControllerName  )  [protected]

return page errors array

Parameters:
string $sCurrentControllerName a class name
Returns:
array

Definition at line 517 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 422 of file oxshopcontrol.php.

oxShopControl._getFrontendMallStartController (  )  [protected]

Returns start controller class name for frontend mall. If no class specified, we need to change back to base shop

Returns:
string

Definition at line 724 of file oxshopcontrol.php.

oxShopControl._getFrontendStartController (  )  [protected]

Returns which controller should be loaded at shop start. Check whether we have to display mall start screen or not.

Returns:
string

Definition at line 708 of file oxshopcontrol.php.

oxShopControl._getOutputManager (  )  [protected]

return output handler

Returns:
oxOutput

Definition at line 501 of file oxshopcontrol.php.

oxShopControl._getStartController (  )  [protected]

Returns controller class which should be loaded.

Returns:
string

Definition at line 690 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:
oxException $oEx Exception

Definition at line 650 of file oxshopcontrol.php.

oxShopControl._handleBaseException ( oEx  )  [protected]

Catching other not caught exceptions.

Parameters:
oxException $oEx

Definition at line 675 of file oxshopcontrol.php.

oxShopControl._handleCookieException ( oEx  )  [protected]

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

Parameters:
oxException $oEx Exception

Definition at line 637 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 660 of file oxshopcontrol.php.

oxShopControl._handleSystemException ( oEx  )  [protected]

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

Parameters:
oxException $oEx

Definition at line 620 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 371 of file oxshopcontrol.php.

oxShopControl._isDebugMode (  )  [protected]

Checks if shop is in debug mode

Returns:
bool

Definition at line 603 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

Definition at line 142 of file oxshopcontrol.php.

oxShopControl._render ( oViewObject  )  [protected]

render oxView object

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

Definition at line 445 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 550 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 126 of file oxshopcontrol.php.

oxShopControl._startMonitor (  )  [protected]

Starts resource monitor

Definition at line 178 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

Definition at line 193 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 253 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). Additionally its possible to pass class name, function name and parameters array to view, which will be executed.

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

Reimplemented in oxWidgetControl.

Definition at line 95 of file oxshopcontrol.php.


Member Data Documentation

oxShopControl.$_aAllErrors = null [protected]

Definition at line 56 of file oxshopcontrol.php.

oxShopControl.$_aControllerErrors = null [protected]

Definition at line 65 of file oxshopcontrol.php.

oxShopControl.$_aErrors = null [protected]

Definition at line 47 of file oxshopcontrol.php.

oxShopControl.$_blHandlerSet = null [protected]

Reimplemented in oxWidgetControl.

Definition at line 17 of file oxshopcontrol.php.

oxShopControl.$_blMainTasksExecuted = null [protected]

Reimplemented in oxWidgetControl.

Definition at line 24 of file oxshopcontrol.php.

oxShopControl.$_dTimeEnd = null [protected]

Definition at line 38 of file oxshopcontrol.php.

oxShopControl.$_dTimeStart = null [protected]

Definition at line 31 of file oxshopcontrol.php.

oxShopControl.$_oCache = null [protected]

Definition at line 82 of file oxshopcontrol.php.

oxShopControl.$_oOutput = null [protected]

Definition at line 75 of file oxshopcontrol.php.


The documentation for this class was generated from the following file: