Class Legacy_Controller
This class is a virtual controller that has the compatibility with XOOPS 2.0.x.
[NOTICE] XOOPS 2.0.x can switch to public mode and control panel mode. This controller emulates its process with using STATE. But, we may lose flexible setup by this implement. Now, we are investigating the influence.
[TODO] XCube_Controller keeps a process that set up instances of some legacy classes, yet. We should move its process to this controller.
- XCube_Controller
- 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
|
|
public
|
#
executeCommonSubset( boolean $connectdb = true )
Subset of executeCommon() Method It'll be used when process starts with $xoopsOption['nocommon'] and This process requires connecting XOOPS Database or LEGACY constant values But it won't do any other initial settings (eg. Session start, Permission handling) |
public
|
|
public
&
|
|
public
|
|
public
|
#
_setupEnvironment( )
This member function is overridden. Sets up the controller and the environment. |
public
|
#
_setupFilterChain( )
[NOTICE] We set up only filters that are decided to register by us. This is not flexible. This is not the style fixed. |
public
|
|
public
|
#
_processBlock( )
Process of Block. Fetch objects from $this->mBlockChain, render the result of the object with html data, and set those result to member property. |
public
|
|
public
|
|
public
|
|
public
|
|
public
|
#
_setupUser( )
Sets up a principal object to the root object. In other words, restores the principal object from session or other. |
public
|
|
public
|
|
public
|
#
_setupLanguage( )
Create a instance of Legacy_LanguageManager by the specified language, and set it to member properties. |
public
|
#
_createLanguageManager( string $language )
Factory for the language manager. At first, this member function delegates to get a instance of LanguageManager. If it can't get it, do the following process: |
public
|
#
_setupConfig( )
This member function is overridden. Loads site configuration informations, and sets them to the member property. |
public
|
|
public
|
|
public
|
#
_processPreBlockFilter( )
Calls the preBlockFilter() member function of action filters which have been loaded to the list of the controller. |
public
|
|
public
|
#
_setupSession( )
This member function is overridden. Sets up handler for session, then starts session. |
protected
|
|
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
|
#
_executeViewTheme( & $resultRenderTarget )
$resultRenderTarget object The render target of content's result. |
public
|
|
public
|
|
public
|
#
checkLogin( )
Check the login request through delegates, and set XoopsObject to member property if the login is success. |
public
|
|
public
|
#
setStrategy( Legacy_AbstractControllerStrategy & $strategy )
CAUTION!! This method has a special mission. Because this method changes state after executeCommon, this resets now property. It depends on XCube_Controller steps. |
public
|
#
setDialogMode( $flag $flag )
Set bool flag to dialog mode flag. If you set true, executeView() will use Legacy_DialogRenderTarget class as render target. |
public
boolean
|
|
public
|
#
getVirtualCurrentModule( )
Return current module object. But, it's decided by the rules of the state. Preferences page, Help page and some pages returns the specified module by dirname. It's useful for controlling a theme. |
public
|
#
executeRedirect( string $url, integer $time = 1, string $message = null, boolean $addRedirect = true )
This member function works to redirect as well as redirect_header(). But, this member function handles raw values which hasn't been converted by htmlspecialchars(). Therefore, if user calls this function with the wrong value, some problems may be raised. If you can't understand the difference, use not this function but redirect_header(). |
public
boolean
|
|
public
boolean
|
#
existActiveCacheFile( string $filepath, integer $cachetime )
Gets a value indicating wheter a cache file keeps life time. If $cachetime is 0 or the specific cache file doesn't exist, gets false. |
public
boolean
|
#
cacheRenderTarget( string $filepath,
Save the content of $renderTarget to $filepath. |
public
string
|
|
public
|
|
public
string
|
|
public
string
|
public
boolean
|
$_mAdminModeFlag | false |
|
public
|
$_mStrategy | null |
|
public
boolean
|
$mDialogMode | false |
|
public
|
$mCheckLogin | null |
|
public
|
$mLogout | null |
|
public
|
$mCreateLanguageManager | null |
|
public
|
$mSetBlockCachePolicy | null |
|
public
|
$mActiveModules | null |
|
public
|
$mSetModuleCachePolicy | null |
|
public
|
$mGetLanguageName | null |
|
public
|
$mSetupDebugger | null |
|
public
|
$_mNotifyRedirectToUser | null |
#
[Secret Agreement] In execute_redirect(), notice the redirection which directs toward user.php. |
public
|
$mLogger | null |
$_mBlockChain,
$_mFilterChain,
$_mLoadedFilterNames,
$mDB,
$mExecute,
$mLanguage,
$mLocale,
$mRoot,
$mSetupTextFilter,
$mSetupUser
|