Class XCube_Controller
Virtual or Actual front controller class.
This is an abstract class. And, a sub-class of this class has many impositions which sets up root object finally and implements many actual logic.
executeXXXXX() functions are a public member function called by an accessed file. These member functions call other protected member functions.
_setupXXXXX() functions are a protected member function overridden by a sub-class controller. Most of these functions are empty. A sub-class controller overrides them to set up a controller object and others.
_createXXXXX() functions are a protected member function overridden by a sub-class controller. These member functions are called in prepare() to set up the root object. And, they have been exported from prepare() for a sub-class controller to override easily. Most of sub-class controllers doesn't need to override them, because typical code is there.
Direct known subclasses
Legacy_Controller
public
|
|
public
|
#
prepare(
This member function is overridden. The sub-class implements the initialization process which sets up the root object finally. |
public
|
#
executeCommon( )
This member function is actual initialize process of web application. Some Nuke-like bases call this function at any timing. |
public
|
#
executeHeader( )
Usually this member function is called after executeCommon(). But, some cases don't call this. Therefore, the page controller type base should not write the indispensable code here. For example, this is good to call blocks. |
public
|
|
public
|
|
public
|
#
executeForward( string $url, integer $time = 0, string $message = null )
TODO We may change this name to forward() |
public
|
#
executeRedirect( string $url, integer $time = 1, string $message = null )
Redirect to the specified URL with displaying message. |
public
|
|
public
|
|
public
|
#
_setupEnvironment( )
This member function is overridden. Sets up the controller and the environment. |
public
|
|
public
&
|
|
public
|
|
public
|
|
public
|
#
_setupConfig( )
This member function is overridden. Loads site configuration informations, and sets them to the member property. |
public
|
#
_setupSession( )
This member function is overridden. Sets up handler for session, then starts session. |
public
|
#
_setupUser( )
Sets up a principal object to the root object. In other words, restores the principal object from session or other. |
public
|
#
_processFilter( )
Calls the preFilter() member function of action filters which have been loaded to the list of the controller. |
public
|
|
public
|
|
public
|
#
_processPreBlockFilter( )
Calls the preBlockFilter() member function of action filters which have been loaded to the list of the controller. |
public
|
#
_processPostFilter( )
Calls the postFilter() member function of action filters which have been loaded to the list of the controller. |
public
|
#
_processPreload( $path $path )
This is 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. |
public
|
|
public
|
|
public
XCube_PermissionManager
&
|
|
public
|
|
public
|
public
|
$mRoot |
|
#
The reference for the root object. |
public
Array
|
$_mBlockChain | array() |
#
Array of a procedure class object. |
public
Array
|
$_mFilterChain | array() |
#
Vector Array of XCube_ActionFilter class object. |
public
array
|
$_mLoadedFilterNames | array() |
#
This is Map-Array to keep names of action filter classes which are applied as filters. |
public
object
|
$mDB |
|
#
The database object which is abstract layer for the database. |
public
string
|
$mLocale | null |
#
A name of the current local. |
public
string
|
$mLanguage | null |
#
A name of the current language. |
public
|
$mSetupUser | null |
#
Rebuilds the principal object for the current HTTP-request. void setupUser(XCube_AbstractPrincipal &, XCube_Controller &, XCube_HttpContext &); |
public
|
$mExecute | null |
#
Executes the main logic of the controller. void execute(XCube_Controller &); |
public
|
$mSetupTextFilter | null |
#
Make a instance of TextFilter. void senupTextFilter(XCube_TextFilter &); |