XCube_HttpContext Class Reference

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

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

getRequest()

& getRequest

(

)

Gets the object which has a interface of XCube_AbstractRequest.

Returns

XCube_AbstractRequest

getThemeName()

getThemeName

(

)

Return the theme name.

Returns

string

Deprecated

getUser()

& getUser

(

)

Gets the object which has a interface of XCube_Principal.

Returns

\XCube_Principal

hasAttribute()

hasAttribute

(

$key

)

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

Parameters

string

$key

Returns

mixed

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

setRequest()

setRequest

(

&

$request

)

Sets the object which has a interface of XCube_AbstractRequest.

Parameters

XCube_AbstractRequest

$request

setThemeName()

setThemeName

(

string

$theme

)

Set the theme name.

Parameters

string

$theme

Deprecated

setUser()

setUser

(

&

$principal

)

Sets the object which has a interface of XCube_Principal. XCube_AbstractPrincipal

Parameters

$principal

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

$mRequest

$mRequest

The object which enables to read the request values.

@access XCube_AbstractRequest

$mThemeName

$mThemeName

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

@access private

---

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

• C:/Ampps/www/legacy250/html/core/XCube_HttpContext.class.php