dmRequest Class Reference

Static Public Member Functions


Detailed Description

Definition at line 15 of file dmRequest.class.php.


Member Function Documentation

static dmRequest::GET ( key = null  )  [static, final]
Parameters:
string key
Returns:
The HTTP GET parameter corresponding to $key, or false if not available. If $key is not supplied, returns all GET variables as an associative array.

Definition at line 23 of file dmRequest.class.php.

Referenced by ObjectDraw::compoundObjectSearchForm(), ResultsDraw::facetsAsUL(), dmRoute::getCurrent(), Draw::getFeedURL(), ObjectDraw::highlightedFullText(), ResultsDraw::pageLinks(), ResultsDraw::results(), ObjectResultsDraw::results(), ResultsDraw::sortLinksAsUL(), ResultsDraw::thumbsToggleLink(), and ResultsDraw::viewLinks().

static dmRequest::getBuiltURI ( params,
array $  query = array(),
format = null,
mobile = false 
) [static, final]

Returns a URI relative to the web server's document root.

Parameters:
string params
array query Array of query string key-value pairs in the format accepted by http_build_query()
string format A ".format" to append to the URL, or null for none
Boolean mobile
Returns:
string

Definition at line 58 of file dmRequest.class.php.

Referenced by ObjectDraw::compoundObjectSearchForm(), SearchDraw::dateSearch(), ResultsDraw::facetsAsUL(), SearchDraw::fieldSearch(), Draw::getFeedURL(), dmObject::getRecordURL(), dmQuery::getURL(), ObjectDraw::metadataAsDL(), SearchDraw::proximitySearch(), ObjectDraw::ratingsSection(), ResultsDraw::sortLinksAsUL(), ResultsDraw::thumbsToggleLink(), and ResultsDraw::viewLinks().

static dmRequest::getPageURI (  )  [static, final]

Returns the absolute URI of the current page, minus any query string arguments.

Returns:
string
See also:
dmRequest::getServerURI()
dmRequest::getURI()

Definition at line 99 of file dmRequest.class.php.

static dmRequest::getServerURI (  )  [static, final]

Returns the absolute URI of the web server.

Returns:
string
See also:
dmRequest::getPageURI()
dmRequest::getURI()

Definition at line 146 of file dmRequest.class.php.

Referenced by dmCdmUser::authenticate(), getPageURI(), dmObject::getRecordURL(), and getURI().

static dmRequest::getURI (  )  [static, final]

Returns the current full absolute URI.

Returns:
string
See also:
dmRequest::getPageURI()
dmRequest::getServerURI()

Definition at line 165 of file dmRequest.class.php.

Referenced by dmException::getURL(), dmErrorException::getURL(), ObjectDraw::previousNextLinks(), and reload().

static dmRequest::isValidURL ( str  )  [static, final]
Parameters:
string str
Since:
0.4

Definition at line 194 of file dmRequest.class.php.

static dmRequest::POST ( key = null  )  [static, final]

Returns the HTTP POST parameter corresponding to $key, or false if not available.

If $key is not supplied, returns all POST variables as an associative array.

Parameters:
string key
Returns:
array|string|null

Definition at line 39 of file dmRequest.class.php.

Referenced by dmRoute::getCurrent().

static dmRequest::redirectToParams ( params,
array $  query = array() 
) [static, final]

Redirects to a given set of URI params, in controller/id/method format (id is optional).

Must be called before the HTTP header has been output.

Parameters:
string params
array query Optional array of key => value query string pairs
Since:
0.1

Definition at line 111 of file dmRequest.class.php.

static dmRequest::reload (  )  [static, final]

Redirects to the current request URI.

Since:
0.1

Definition at line 135 of file dmRequest.class.php.

static dmRequest::unMagicQuotes ( &$  array_or_string  )  [static]

Reverses the effect of PHP magic quotes, if enabled, by running stripslashes() on $array_or_string.

Modifies it by reference and returns void.

Parameters:
array_or_string 
Returns:
void
Since:
0.1

Definition at line 177 of file dmRequest.class.php.


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

Generated on Fri Aug 20 13:16:50 2010 for dmBridge PHP API by  doxygen 1.6.1