Request Class Reference

Inheritance diagram for Request:

Collaboration diagram for Request:

Public Member Functions
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	getIterator ()

Static Public Member Functions
static	getInstance ()
static	url ()
static	protocol ()
static	server ()
static	path ()
static	set ($param, $value)
static	get ($param, $default=NULL)
static	quoted ($param, $default=NULL)
static	option ($param, $default=NULL)
static	int ($param, $default=NULL)
static	float ($param, $default=NULL)
static	getArray ($param)
static	quotedArray ($param)
static	optionArray ($param)
static	intArray ($param)
static	floatArray ($param)
static	submitted ($param)
static	addslashes ($value)
static	removeMagicQuotes ($value)

Detailed Description

Singleton class representing a HTTP request in Stud.IP.

Member Function Documentation

static addslashes (   $value )

static

Quote a given string or array using addslashes(). If the parameter is an array, the quoting is applied recursively.

Parameters

mixed

$value

string or array value to be quoted

Returns

mixed quoted string or array

Here is the caller graph for this function:

static float (   $param,   $default = NULL  )

static

Return the value of the selected query parameter as a float.

Parameters

string	$param	parameter name
float	$default	default value if parameter is not set

Returns

float parameter value as float (if set), else NULL

Here is the call graph for this function:

Here is the caller graph for this function:

static floatArray (   $param )

static

Return the value of the selected query parameter as a float array.

Parameters

string

$param

parameter name

Returns

array parameter value as array (if set), else an empty array

Here is the call graph for this function:

static get (   $param,   $default = NULL  )

static

Return the value of the selected query parameter as a string.

Parameters

string	$param	parameter name
string	$default	default value if parameter is not set

Returns

string parameter value as string (if set), else NULL

Here is the call graph for this function:

Here is the caller graph for this function:

static getArray (   $param )

static

Return the value of the selected query parameter as an array.

Parameters

string

$param

parameter name

Returns

array parameter value as array (if set), else an empty array

Here is the call graph for this function:

Here is the caller graph for this function:

static getInstance ( )

static

Return the Request singleton instance.

Here is the caller graph for this function:

getIterator

(

)

IteratorAggregate: Create interator for request parameters.

static int (   $param,   $default = NULL  )

static

Return the value of the selected query parameter as an integer.

Parameters

string	$param	parameter name
int	$default	default value if parameter is not set

Returns

int parameter value as integer (if set), else NULL

Here is the call graph for this function:

Here is the caller graph for this function:

static intArray (   $param )

static

Return the value of the selected query parameter as an integer array.

Parameters

string

$param

parameter name

Returns

array parameter value as array (if set), else an empty array

Here is the call graph for this function:

Here is the caller graph for this function:

offsetExists

(

$offset

)

ArrayAccess: Check whether the given offset exists.

offsetGet

(

$offset

)

ArrayAccess: Get the value at the given offset.

offsetSet	(		$offset,
			$value
	)

ArrayAccess: Set the value at the given offset.

offsetUnset

(

$offset

)

ArrayAccess: Delete the value at the given offset.

static option (   $param,   $default = NULL  )

static

Return the value of the selected query parameter as an alphanumeric string (consisting of only digits, letters and underscores).

Parameters

string	$param	parameter name
string	$default	default value if parameter is not set

Returns

string parameter value as string (if set), else NULL

Here is the call graph for this function:

Here is the caller graph for this function:

static optionArray (   $param )

static

Return the value of the selected query parameter as an array of alphanumeric strings (consisting of only digits, letters and underscores).

Parameters

string

$param

parameter name

Returns

array parameter value as array (if set), else an empty array

Here is the call graph for this function:

Here is the caller graph for this function:

static path ( )

static

Return the current request path, relative to the server root.

Here is the caller graph for this function:

static protocol ( )

static

Return the current protocol ('http' or 'https').

Here is the caller graph for this function:

static quoted (   $param,   $default = NULL  )

static

Return the value of the selected query parameter as a string. The contents of the string is quoted with addslashes().

Parameters

string	$param	parameter name
string	$default	default value if parameter is not set

Returns

string parameter value as string (if set), else NULL

Here is the call graph for this function:

Here is the caller graph for this function:

static quotedArray (   $param )

static

Return the value of the selected query parameter as a string array. The contents of each element is quoted with addslashes().

Parameters

string

$param

parameter name

Returns

array parameter value as array (if set), else an empty array

Here is the call graph for this function:

static removeMagicQuotes (   $value )

static

Strip magic quotes from a given string or array. If the PHP setting "magic_quotes_gpc" is enabled, stripslashes() is used on the value. If the parameter is an array, magic quoting is stripped recursively.

Parameters

mixed

$value

string or array value to be unquoted

Returns

mixed unquoted string or array

Here is the caller graph for this function:

static server ( )

static

Return the current server name and port (host:port).

Here is the caller graph for this function:

static set (   $param,   $value  )

static

Set the selected query parameter to a specific value.

Parameters

string	$param	parameter name
mixed	$value	parameter value (string or array)

Here is the call graph for this function:

Here is the caller graph for this function:

static submitted (   $param )

static

Check whether a form submit button has been pressed. This works for both image and text submit buttons.

Parameters

string

$param

submit button name

Returns

boolean true if the button has been submitted, else false

Here is the call graph for this function:

Here is the caller graph for this function:

static url ( )

static

Return the current URL, including query parameters.

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• lib/classes/Request.class.php