[Secret Agreement] The context class for Legacy which extends to keep Legacy-module-specific information. More...

Inheritance diagram for Legacy_HttpContext:

Public Member Functions
	getXoopsConfig ($id=null)
	Gets a value of XoopsConfig by $id.

	setThemeName ($name)
	Sets the name of the current theme.

Public Member Functions inherited from XCube_HttpContext
	setAttribute ( $key, $value)

	hasAttribute ( $key)

	getAttribute ( $key)

	setRequest (&$request)

&	getRequest ()

	setUser (&$principal)

&	getUser ()

	setThemeName (string $theme)

	getThemeName ()

Data Fields
	$mXoopsUser = null
	[READ ONLY] XoopsUser - The current user profile object.

	$mModule = null
	[READ ONLY] Legacy_AbstractModule - The current module instance.

	$mXoopsModule = null
	[READ ONLY] XoopsModule - The current Xoops Module object.

	$mXoopsConfig = []
	[READ ONLY] Map Array - std::map<string, mixed>

	$mModuleConfig = []

	$mBaseRenderSystemName = ''

Data Fields inherited from XCube_HttpContext
	$mAttributes = []

	$mRequest

	$mUser

	$mType = XCUBE_CONTEXT_TYPE_DEFAULT

	$mThemeName

Detailed Description

[Secret Agreement] The context class for Legacy which extends to keep Legacy-module-specific information.

Attention: Only Legacy_Controller or its sub-classes calls this constructor.

Definition at line 24 of file Legacy_HttpContext.class.php.

Member Function Documentation

◆ getXoopsConfig()

getXoopsConfig ( $id = null )

Gets a value of XoopsConfig by $id.

Parameters

string $id

Returns: mixed

Definition at line 82 of file Legacy_HttpContext.class.php.

◆ setThemeName()

setThemeName ( $name )

Sets the name of the current theme.

Parameters

string $theme

Returns: void

Attention: This method is for the theme changer feature. However, this API will be changed.

Definition at line 104 of file Legacy_HttpContext.class.php.

Field Documentation

◆ $mBaseRenderSystemName

$mBaseRenderSystemName = ''

Definition at line 74 of file Legacy_HttpContext.class.php.

◆ $mModule

$mModule = null

[READ ONLY] Legacy_AbstractModule - The current module instance.

Definition at line 36 of file Legacy_HttpContext.class.php.

◆ $mModuleConfig

$mModuleConfig = []

Definition at line 65 of file Legacy_HttpContext.class.php.

◆ $mXoopsConfig

$mXoopsConfig = []

[READ ONLY] Map Array - std::map<string, mixed>

This is string collection which indicates site configurations by a site owner.
Those configurations' information are loaded by the controller, and set. This
configuration and the site configuration of XCube_Root are different.

The array for Xoops, which is configured in the preference of the base. This
property and $xoopsConfig (X2) is the same.

Definition at line 57 of file Legacy_HttpContext.class.php.