XCube_Root Class Reference

List of all members.

Public Member Functions

getSingleton ()
 loadSiteConfig ()
 setSiteConfig ($config)
 overrideSiteConfig ($config)
 getSiteConfig ()
 setupController ()
getController ()
 setLanguageManager (&$languageManager)
getLanguageManager ()
 setDelegateManager (&$delegateManager)
getDelegateManager ()
 setServiceManager (&$serviceManager)
getServiceManager ()
getRenderSystem ($name)
 setRoleManager (&$manager)
 setContext (&$context)
getContext ()
_createInstance ($className, $classPath=null)

Public Attributes

 $mController = null
 $mLanguageManager = null

Detailed Description

This class offers the access course same as global variable for a logic in old mechanism. This class does not let you depend on a main controller class name You must not succeed to this class.


Member Function Documentation

& XCube_Root::getSingleton (  ) 

Return a object of XCube_Root as singleton.

Returns:
XCube_Root

XCube_Root::loadSiteConfig (  ) 

Load SiteConfig from plural files, and control set and override site config.

Returns:
void

XCube_Root::setSiteConfig ( config  ) 

Set site configs.

Parameters:
array $config

XCube_Root::overrideSiteConfig ( config  ) 

Override site config. SiteConfig is overrided by $config value. And, if $config has new key, that key is set.

Parameters:
array $config

XCube_Root::getSiteConfig (  ) 

Return the value of site config that is defined by ini files.

Returns:
mixed If the value specified by parameters is no, return null.

XCube_Root::setupController (  ) 

Create controller with the rule, and call member function prepare(). The class of creating controller is defined in ini.php files.

Returns:
void

& XCube_Root::getController (  ) 

Return the instance of the controller.

Returns:
XCube_Controller

XCube_Root::setLanguageManager ( &$  languageManager  ) 

Set the instance of the language manager.

Parameters:
$languageManager XCube_LanguageManager
Returns:
void

& XCube_Root::getLanguageManager (  ) 

Return the instance of the language manager.

Returns:
XCube_LanguageManager

XCube_Root::setDelegateManager ( &$  delegateManager  ) 

Set the instance of the delegate manager.

Parameters:
$delegateManager XCube_DelegateManager
Returns:
void

& XCube_Root::getDelegateManager (  ) 

Return the instance of the delegate manager.

Returns:
XCube_DelegateManager

XCube_Root::setServiceManager ( &$  serviceManager  ) 

Set the instance of the service manager.

Parameters:
$languageManager XCube_ServiceManager
Returns:
void

& XCube_Root::getServiceManager (  ) 

Return the instance of the service manager.

Returns:
XCube_ServiceManager

& XCube_Root::getRenderSystem ( name  ) 

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().

Todo:
Parameters:
$name string the registed name of the render system.

XCube_Root::setRoleManager ( &$  manager  ) 

Sets the role manager object.

XCube_Root::setContext ( &$  context  ) 

Sets the HTTP-context object.

Parameters:
XCube_Context $context

& XCube_Root::getContext (  ) 

Gets the HTTP-context object.

Returns:
XCube_Context

& XCube_Root::_createInstance ( className,
classPath = null 
)

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

Parameters:
$className string the name of class.
$classPath string the path that $className is defined in.
Returns:
void
Todo:
If the file doesn't exist, require_once() raises fatal errors.


Member Data Documentation

XCube_Root::$mController = null

private

XCube_Root::$mLanguageManager = null

private ?


The documentation for this class was generated from the following file:
Generated on Thu Nov 2 00:27:24 2006 for XOOPS Cube Legacy by  doxygen 1.5.1