Class SGL_Request

Description

Loads Request driver, provides a number of filtering methods.

Located in /SGL/Request.php (line 54)


			
Direct descendents
Class Description
SGL_Request_Ajax Loads Request driver, provides a number of filtering methods.
SGL_Request_Browser2 Browser2 request type, which uses Horder_Routes package to resolve query data, instead SGL_Url heavy parsing used by Browser1.
SGL_Request_Browser Loads Request driver, provides a number of filtering methods.
SGL_Request_Cli Loads Request driver, provides a number of filtering methods.
Variable Summary
 mixed $aProps
Method Summary
 static mixed &singleton ([ $forceNew = false], [ $type = null])
 void add ( $aParams)
 void constantToString ( $constant)
 void debug ()
 mixed get ( $key, [boolean $allowTags = false], mixed $paramName)
 void getActionName ()
 array getAll ()
 void getManagerName ()
 void getModuleName ()
 integer getType ()
 void getUri ()
 void init ([ $type = null])
 void isEmpty ()
 void merge ( $aHash)
 void reset ()
 void set ( $key, mixed $value, mixed $name)
 integer _getRequestType ()
Variables
mixed $aProps (line 56)
Methods
static singleton (line 151)

Returns a singleton Request instance.

example usage: $req = & SGL_Request::singleton(); warning: in order to work correctly, the request singleton must be instantiated statically and by reference

  • return: reference to Request object
  • access: public
mixed &singleton ([ $forceNew = false], [ $type = null])
  • $forceNew
  • $type
add (line 229)
void add ( $aParams)
  • $aParams
constantToString (line 86)
void constantToString ( $constant)
  • $constant
debug (line 300)
void debug ()
get (line 193)

Retrieves values from Request object.

  • return: Request param value or null if not exists
  • access: public
mixed get ( $key, [boolean $allowTags = false], mixed $paramName)
  • mixed $paramName: Request param name
  • boolean $allowTags: If html/php tags are allowed or not
  • $key
getActionName (line 269)
void getActionName ()

Redefined in descendants as:
getAll (line 244)

Return an array of all Request properties.

array getAll ()
getManagerName (line 259)
void getManagerName ()
getModuleName (line 249)
void getModuleName ()
getType (line 172)

Returns constant representing request type.

integer getType ()
getUri (line 279)
void getUri ()
init (line 58)
void init ([ $type = null])
  • $type

Redefined in descendants as:
isEmpty (line 162)
void isEmpty ()
merge (line 177)
void merge ( $aHash)
  • $aHash
reset (line 234)
void reset ()
set (line 224)

Set a value for Request object.

  • access: public
void set ( $key, mixed $value, mixed $name)
  • mixed $name: Request param name
  • mixed $value: Request param value
  • $key
_getRequestType (line 119)

Used internally to determine request type before Request strategy instantiated.

integer _getRequestType ()

Documentation generated on Tue, 23 Feb 2010 18:14:33 +0000 by phpDocumentor 1.4.3