XCL Web Application Platform 2.5.0
The XoopsCube Legacy Project
Loading...
Searching...
No Matches
XCube_HttpContext Class Reference
Inheritance diagram for XCube_HttpContext:
Legacy_HttpContext

Public Member Functions

 setAttribute ( $key, $value)
 
 hasAttribute ( $key)
 
 getAttribute ( $key)
 
 setRequest (&$request)
 
getRequest ()
 
 setUser (&$principal)
 
getUser ()
 
 setThemeName (string $theme)
 
 getThemeName ()
 

Data Fields

 $mAttributes = []
 
 $mRequest
 
 $mUser
 
 $mType = XCUBE_CONTEXT_TYPE_DEFAULT
 
 $mThemeName
 

Detailed Description

Definition at line 17 of file XCube_HttpContext.class.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( )

Definition at line 54 of file XCube_HttpContext.class.php.

Member Function Documentation

◆ getAttribute()

getAttribute ( $key)

Gets a value of attributes with $key. If the value specified by $key doesn't exist in attributes, gets null.

Parameters
string$key
Returns
mixed

Definition at line 88 of file XCube_HttpContext.class.php.

◆ getRequest()

& getRequest ( )

Gets the object which has a interface of XCube_AbstractRequest.

Returns
XCube_AbstractRequest

Definition at line 107 of file XCube_HttpContext.class.php.

◆ getThemeName()

getThemeName ( )

Return the theme name.

Returns
string
Deprecated

Definition at line 147 of file XCube_HttpContext.class.php.

◆ getUser()

& getUser ( )

Gets the object which has a interface of XCube_Principal.

Returns
\XCube_Principal

Definition at line 126 of file XCube_HttpContext.class.php.

◆ hasAttribute()

hasAttribute ( $key)

Gets a value indicating whether the value specified by $key exists.

Parameters
string$key
Returns
mixed

Definition at line 76 of file XCube_HttpContext.class.php.

◆ setAttribute()

setAttribute ( $key,
$value )

Sets $value with $key to attributes. Use direct access to $mAttributes if references are must, because PHP4 can't handle reference in the signature of this member function.

Parameters
string$key
mixed$value

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

◆ setRequest()

setRequest ( & $request)

Sets the object which has a interface of XCube_AbstractRequest.

Parameters
XCube_AbstractRequest$request

Definition at line 98 of file XCube_HttpContext.class.php.

◆ setThemeName()

setThemeName ( string $theme)

Set the theme name.

Parameters
string$theme
Deprecated

Definition at line 137 of file XCube_HttpContext.class.php.

◆ setUser()

setUser ( & $principal)

Sets the object which has a interface of XCube_Principal. XCube_AbstractPrincipal

Parameters
$principal

Definition at line 117 of file XCube_HttpContext.class.php.

Field Documentation

◆ $mAttributes

$mAttributes = []

Hashmap that can be used to organize and share data. Use setAttribute() and get Attribute() to access this member property. But, direct access is allowed, because it is impossible to handle reference well on older PHP versions. Array

@access protected

Definition at line 26 of file XCube_HttpContext.class.php.

◆ $mRequest

$mRequest

The object which enables to read the request values.

@access XCube_AbstractRequest

Definition at line 33 of file XCube_HttpContext.class.php.

◆ $mThemeName

$mThemeName

The theme is one in one time of request. A decided theme is registered with this property

@access private

Definition at line 52 of file XCube_HttpContext.class.php.

◆ $mType

$mType = XCUBE_CONTEXT_TYPE_DEFAULT

Definition at line 44 of file XCube_HttpContext.class.php.

◆ $mUser

$mUser

Definition at line 38 of file XCube_HttpContext.class.php.


The documentation for this class was generated from the following file: