XCube_HttpContext Class Reference

Inherited by Legacy_HttpContext.

Inheritance diagram for XCube_HttpContext:

[legend]
List of all members.

Public Member Functions

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

Public Attributes

 $mRequest = null
 $mThemeName = null

Detailed Description

Encapsulates major HTTP specific information about a HTTP request.


Member Function Documentation

XCube_HttpContext::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

XCube_HttpContext::hasAttribute ( key  ) 

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

Parameters:
string $key
Returns:
mixed

XCube_HttpContext::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

XCube_HttpContext::setRequest ( &$  request  ) 

Sets the object which has a interface of XCube_AbstractRequest.

Parameters:
XCube_AbstractRequest $request

& XCube_HttpContext::getRequest (  ) 

Gets the object which has a interface of XCube_AbstractRequest.

Returns:
XCube_AbstractRequest

XCube_HttpContext::setUser ( &$  principal  ) 

Sets the object which has a interface of XCube_Principal.

Parameters:
XCube_AbstractPrincipal $principal

& XCube_HttpContext::getUser (  ) 

Gets the object which has a interface of XCube_Principal.

Returns:
XCube_AbstractPrincipal

XCube_HttpContext::setThemeName ( theme  ) 

Set the theme name.

Parameters:
$theme string
Deprecated:

Reimplemented in Legacy_HttpContext.

XCube_HttpContext::getThemeName (  ) 

Return the theme name.

Returns:
string
Deprecated:


Member Data Documentation

XCube_HttpContext::$mRequest = null

The object which enables to read the request values.

XCube_AbstractRequest

XCube_HttpContext::$mThemeName = null

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

private


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