XCube_Controller Class Reference

Public Member Functions
	prepare (&$root)
	executeCommon ()
	executeHeader ()
	execute ()
	executeView ()
	executeForward (string $url, int $time=0, string $message=null)
	executeRedirect (string $url, int $time=1, string $message=null)
	addActionFilter (&$filter)
	_setupFilterChain ()
	_setupEnvironment ()
	_setupDB ()
&	getDB ()
	_setupLanguage ()
	_setupTextFilter ()
	_setupConfig ()
	_setupSession ()
	_setupUser ()
	_processFilter ()
	_setupBlock ()
	_processBlock ()
	_processPreBlockFilter ()
	_processPostFilter ()
	_processPreload ( $path)
&	_createDelegateManager ()
&	_createServiceManager ()
&	_createPermissionManager ()
&	_createRoleManager ()
&	_createContext ()

Data Fields
	$mRoot
	$_mBlockChain = []
	$_mFilterChain = []
	$_mLoadedFilterNames = []
	$mDB
	$mLocale
	$mLanguage
	$mSetupUser = null
	$mExecute = null
	$mSetupTextFilter = null

Member Function Documentation

_createContext()

& _createContext

(

)

Creates the context object to initial the root object, and returns it.

Returns

XCube_HttpContext

_createDelegateManager()

& _createDelegateManager

(

)

Creates an instance of the delegate manager and returns it.

Returns

XCube_DelegateManager

_createPermissionManager()

& _createPermissionManager

(

)

Creates an instance of the permission manager and returns it. XCube_PermissionManager Object

Returns

_createRoleManager()

& _createRoleManager

(

)

Creates an instance of the role manager and returns it. XCube_RoleManager

Returns

Object

_createServiceManager()

& _createServiceManager

(

)

Creates an instance of the service manager and returns it.

Returns

XCube_ServiceManager

_processBlock()

_processBlock

(

)

!FIXME.

_processFilter()

_processFilter

(

)

Calls the preFilter() member function of action filters which have been loaded to the list of the controller.

@access protected

_processPostFilter()

_processPostFilter

(

)

Calls the postFilter() member function of action filters which have been loaded to the list of the controller.

@access protected

_processPreBlockFilter()

_processPreBlockFilter

(

)

Calls the preBlockFilter() member function of action filters which have been loaded to the list of the controller.

@access protected

_processPreload()

_processPreload

(

$path

)

This is an utility member function for the sub-class controller. Load files with the rule from $path, and add the instance of the sub-class to the chain.

@access protected

Parameters

string

$path

Absolute path.

_setupBlock()

_setupBlock

(

)

!FIXME.

_setupConfig()

_setupConfig

(

)

This member function is overridden. Loads site configuration information, and sets them as a member property.

_setupDB()

_setupDB

(

)

Creates the instance of the DataBase class, and sets it as a member property.

@access protected

_setupEnvironment()

_setupEnvironment

(

)

This member function is overridden. Set up the controller and the environment.

_setupFilterChain()

_setupFilterChain

(

)

Create filter chain. @access protected

_setupLanguage()

_setupLanguage

(

)

Creates the instance of Language Manager class, and sets it as a member property.

@access protected

_setupSession()

_setupSession

(

)

This member function is overridden. Set up the session manager, then start the session.

@access protected

Returns

void

_setupTextFilter()

_setupTextFilter

(

)

Creates the instance of Text Filter class, and sets it as a member property.

@access protected

_setupUser()

_setupUser

(

)

Sets a main object to the root object. In other words, it restores the main object of the session or similar.

addActionFilter()

addActionFilter

(

&

$filter

)

Adds the ActionFilter instance.

Parameters

XCube_ActionFilter

$filter

execute()

execute

(

)

Executes the main logic.

@access public

executeCommon()

executeCommon

(

)

This member function is the actual initialization process of the web application. Some Nuke-like bases might call this function at any time.

@access public

executeForward()

executeForward	(	string	$url,
		int	$time = 0,
		string	$message = null )

TODO We may change this name to forward()

Parameters

string	$url	Can't use html tags.
int	$time
string | null	$message

executeHeader()

executeHeader

(

)

Usually this member function is called after executeCommon(). But, some bases don't call this. Therefore, the page controller type base does not have to write the necessary code here. For example, this is good to call blocks.

executeRedirect()

executeRedirect	(	string	$url,
		int	$time = 1,
		string	$message = null )

Redirect to the specified URL with displaying message.

Parameters

string	$url	Can't use html tags.
int	$time
string | null	$message

executeView()

executeView

(

)

Executes the view logic. This member function is overridden.

@access public

getDB()

& getDB

(

)

Gets the DB instance.

@access public

prepare()

prepare

(

&

$root

)

This member function is overridden. The subclass implements the initialization process that sets up the final root object.

Parameters

XCube_Root

$root

Field Documentation

$_mBlockChain

$_mBlockChain = []

Array of a procedure class object.

$_mFilterChain

$_mFilterChain = []

Vector Array of XCube_ActionFilter class object.

Remarks

typedef std:vector<XCube_ActionFilter*> FilterList;
FilterList _mFilterChain;

$_mLoadedFilterNames

$_mLoadedFilterNames = []

This is Map-Array to keep names of action filter classes which are applied as filters.

---

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

• C:/Ampps/www/legacy250/html/core/XCube_Controller.class.php