Methods summary
public static
XCube_Root
&
|
#
getSingleton( )
Returns
Brief
[Static] Gets a object of XCube_Root as singleton.
Public
|
public
|
#
loadSiteConfig( )
Returns
\par $root->loadSiteConfig(string $file1); Loads the site settings from
file1. \par $root->loadSiteConfig(string $file1, string $file2); Loads the
site setting from file1. After that, override file1's setting with file2's
setting.
Attention
Only a base module's boot strap should call this method.
Berif
[Secret Agreement][Overload] Loads SiteConfig from plural files, and control set
and override site config.
Public
|
public
|
#
overrideSiteConfig( array $config )
Parameters
Attention
Only the header of the current base module should call this method.
Brief
[Secret Agreement] Overwrites the current site configs with $config. Override
site config. SiteConfig is overridden by $config value. And, if $config has new
key, that key is set.
Public
|
public
mixed
|
#
getSiteConfig( )
Returns
mixed - If the value specified by parameters is no, return null. \par
$root->getSiteConfig(); Gets array. \par $root->getSiteConfig(string
$groupName); Gets array of the group specified by $groupName. \par
$root->getSiteConfig(string $groupName, string $itemName); Gets a config
value specified by $groupName & $itemName. \par
$root->getSiteConfig(string $groupName, string $itemName, string $default);
If the config value is NOT defined specified by $groupName & $itemName, gets
$default.
Brief
[Overload] Gets a value of site config that is defined by .ini files.
Public
|
public
|
#
setupController( )
Attention
Only the header of the current base module should call this method.
Brief
[Secret Agreement] Creates controller with the rule. Creates controller with the
rule, and call member function prepare(). The class of creating controller is
defined in ini.php files.
Public
|
public
XCube_Controller
&
|
|
public
|
#
setLanguageManager( $languageManager & $languageManager )
Parameters
- $languageManager
$languageManager XCube_LanguageManager
Brief
Sets the XCube_LanguageManager object.
Public
|
public
XCube_LanguageManager
&
|
|
public
|
#
setDelegateManager( $delegateManager & $delegateManager )
Parameters
- $delegateManager
$delegateManager XCube_DelegateManager
Brief
Sets the XCube_DelegateManager object.
Public
|
public
XCube_DelegateManager
&
|
|
public
|
#
setServiceManager( $serviceManager & $serviceManager )
Parameters
- $serviceManager
$serviceManager XCube_ServiceManager
Brief
Sets the XCube_ServiceManager object.
Public
|
public
XCube_ServiceManager
&
|
|
public
XCube_RenderSystem
&
|
#
getRenderSystem( $name $name )
Parameters
- $name
$name string - the registed name of the render system.
Returns
XCube_RenderSystem
Return the instance of the render system by the name. If the render system
specified by $name doesn't exist, raise fatal error. This member function does
creating the instance and calling prepare().
Brief
Gets a RenderSystem object having specified name.
Public
|
public
|
#
setTextFilter( $textFilter & $textFilter )
Parameters
- $textFilter
$textFilter XCube_TextFilter
Brief
Sets a XCube_TextFilter object.
Public
|
public
XCube_TextFilter
&
|
#
getTextFilter( )
Returns
Attention
If mTextFilter member has been not initialized, the root object tries to
generate an instance though XCube_Controller's delegate. This is a special case.
Basically, a class never calls degates of other classes directly.
Brief
Gets a XCube_TextFilter object.
Public
|
public
|
#
setRoleManager( $manager & $manager )
Parameters
- $manager
$manager XCube_RoleManager
Brief
Sets the role manager object.
Public
|
public
|
#
setContext( $context & $context )
Parameters
- $context
$context XCube_Context
Brief
Sets the HTTP-context object.
Public
|
public
XCube_Context
&
|
#
getContext( )
Returns
XCube_Context
Brief
Gets a HTTP-context object.
Public
|
public
|
#
setSession( $session & $session )
Parameters
- $session
$session XCube_Session
Brief
Sets a Session object.
Public
|
public
XCube_Session
&
|
#
getSession( )
Returns
Brief
Gets a Session object.
Public
|
public
Object
&
|
#
_createInstance( $className $className, $classPath $classPath = null, $root $root = null )
Parameters
- $className
$className string - the name of class.
- $classPath
$classPath string - the path that $className is defined in.
- $root
$root string - the root path instead of Cube.Root.
Returns
Object
Brief
Create an instance. Create the instance dynamic with the rule and the string
parameters. First, load the file from $classPath. The rule is XOOPS_ROOT_PATH +
$classPath + $className + .class.php. Next, create the instance of the class if
the class is defined rightly. This member function is called by other member
functions of XCube_Root.
Private
|
Properties summary
public
|
$mController
|
null |
#
Brief
[READ ONLY] XCube_Controller
Public
|
public
|
$mLanguageManager
|
null |
#
Brief
[READ ONLY] XCube_LanguageManager
Public
|
public
|
$mDelegateManager
|
null |
#
Brief
[READ ONLY] XCube_DelegateManager
Public
|
public
|
$mServiceManager
|
null |
#
Brief
[READ ONLY] XCube_ServiceManager
Public
|
public
array
|
$_mRenderSystems
|
array() |
#
Attention
Only the kernel system should access this member property.
Brief
Hash-Map Array - std::map<string, XCube_RenderSystem*> - Caches for
genereted render-systems.
Private
|
public
array
|
$mSiteConfig
|
array() |
#
Brief
[READ ONLY] Hash-Map Array - std::map<string, string>
Public
|
public
|
$mRoleManager
|
null |
#
Brief
[READ ONLY] XCube_RoleManager
Public
|
public
|
$mTextFilter
|
null |
#
See
Attention
In some cases, this member is not initialized. Use getTextFilter().
Brief
[READ ONLY] XCube_TextFilter
Public
|
public
|
$mContext
|
null |
#
Brief
[READ ONLY] XCube_HttpContext
Public
|
public
|
$mSession
|
null |
#
Brief
[READ ONLY] XCube_Session
Public
|