Inheritance diagram for oxShopControl:

Collaboration diagram for oxShopControl:

Public Member Functions
	start ()
	getTotalTime ()
Protected Member Functions
	_log ($sClass, $sFnc)
	_startMonitor ()
	_stopMonitor ($blIsCache=false, $blIsCached=false, $sViewID=null, $aViewData=array())
	_executeMaintenanceTasks ()
	_process ($sClass, $sFunction)
	_initializeViewObject ($sClass, $sFunction)
	_canExecuteFunction ($oClass, $sFunction)
	_getFormattedErrors ()
	_render ($oViewObject)
	_getOutputManager ()
	_output ($sOutput)
	_getErrors ()
	_runOnce ()
	_isDebugMode ()
	_handleSystemException ($oEx)
	_handleCookieException ($oEx)
	_handleAccessRightsException ($oEx)
	_handleDbConnectionException ($oEx)
	_handleBaseException ($oEx)
	_getControllerToLoad ()
Protected Attributes
	$_dTimeStart = null
	$_dTimeEnd = null
	$_aErrors = 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 313 of file oxshopcontrol.php.

oxShopControl._executeMaintenanceTasks ( ) [protected]

Executes regular maintenance functions..

Returns:: null

Definition at line 194 of file oxshopcontrol.php.

oxShopControl._getControllerToLoad ( ) [protected]

Returns controller class which should be loaded.

Returns:: string

Definition at line 600 of file oxshopcontrol.php.

oxShopControl._getErrors ( ) [protected]

return page errors array

Returns:: array

Definition at line 441 of file oxshopcontrol.php.

oxShopControl._getFormattedErrors ( ) [protected]

format error messages from _getErrors and return as array

Returns:: array

Definition at line 332 of file oxshopcontrol.php.

oxShopControl._getOutputManager ( ) [protected]

return output handler

Returns:: oxOutput

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

oxShopControl._handleBaseException ( $ oEx ) [protected]

Catching other not cought exceptions.

Parameters:

oxException

$oEx

Definition at line 586 of file oxshopcontrol.php.

oxShopControl._handleCookieException ( $ oEx ) [protected]

Parameters:

$oEx

Definition at line 545 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 569 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 529 of file oxshopcontrol.php.

oxShopControl._initializeViewObject	(	$	sClass,
		$	sFunction
	)			`[protected]`

initialize and return view object

Parameters:

	string	$sClass view name
	string	$sFunction function name

Returns:: oxView

Definition at line 286 of file oxshopcontrol.php.

oxShopControl._isDebugMode ( ) [protected]

Checks if shop is in debug mode

Returns:: bool

Definition at line 514 of file oxshopcontrol.php.

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

Logs user performad actions to DB. Skips action loggin if it's search engine.

Parameters:

	string	$sClass Name of class
	srring	$sFnc Name of executed class method

Returns:: null

Definition at line 86 of file oxshopcontrol.php.

oxShopControl._output ( $ sOutput ) [protected]

Outputs passed data

Parameters:

string

$sOutput data to output

Deprecated:: from 4.5.0, when removing, use oxoutput directly

See also:: oxOutput

Returns:: null

Definition at line 431 of file oxshopcontrol.php.

oxShopControl._process	(	$	sClass,
		$	sFunction
	)			`[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

Returns:: null

Definition at line 216 of file oxshopcontrol.php.

oxShopControl._render ( $ oViewObject ) [protected]

render oxView object

Parameters:

oxView

$oViewObject view object to render

Returns:: string

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

Definition at line 460 of file oxshopcontrol.php.

oxShopControl._startMonitor ( ) [protected]

Starts resource monitor

Returns:: null

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

oxShopControl.getTotalTime ( )

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

Returns:: double

Definition at line 180 of file oxshopcontrol.php.

oxShopControl.start ( )

Main shop manager, that sets shop status, executes configuration methods. Executes oxShopControl._runOnce(), if needed sets default class (according to admin or regular activities).

Session variables: actshop

Returns:: null

Definition at line 54 of file oxshopcontrol.php.

Member Data Documentation

oxShopControl.$_aErrors = null [protected]

Definition at line 31 of file oxshopcontrol.php.

oxShopControl.$_dTimeEnd = null [protected]

Definition at line 22 of file oxshopcontrol.php.

oxShopControl.$_dTimeStart = null [protected]

Definition at line 15 of file oxshopcontrol.php.

oxShopControl.$_oCache = null [protected]

Definition at line 42 of file oxshopcontrol.php.

oxShopControl.$_oOutput = null [protected]

Definition at line 40 of file oxshopcontrol.php.

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

views/oxshopcontrol.php

oxShopControl Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation