The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form, handling remove of "magic quotes" slashes, stripping illegal input characters and normalizing Unicode sequences. More...

Inheritance diagram for WebRequest:

[legend]

Collaboration diagram for WebRequest:

[legend]

List of all members.

Public Member Functions
	__construct ()
	appendQuery ($query)
	Take an arbitrary query and rewrite the present URL to include it.
	appendQueryArray ($array, $onlyquery=false)
	Appends or replaces value of query variables.
	appendQueryValue ($key, $value, $onlyquery=false)
	checkSessionCookie ()
	Returns true if there is a session cookie set.
	checkUrlExtension ($extWhitelist=array())
	Check if Internet Explorer will detect an incorrect cache extension in PATH_INFO or QUERY_STRING.
	escapeAppendQuery ($query)
	HTML-safe version of appendQuery().
	getAllHeaders ()
	Get an array containing all request headers.
	getArray ($name, $default=null)
	Fetch an array from the input or return $default if it's not set.
	getBool ($name, $default=false)
	Fetch a boolean value from the input or return $default if not set.
	getCheck ($name)
	Return true if the named value is set in the input, whatever that value is (even "0").
	getCookie ($key, $prefix=null, $default=null)
	Get a cookie from the $_COOKIE jar.
	getError ()
	Return the upload error.
	getFileName ($key)
	Return the original filename of the uploaded file, as reported by the submitting user agent.
	getFileSize ($key)
	Return the size of the upload, or 0.
	getFileTempname ($key)
	Return the path to the temporary file where PHP has stored the upload.
	getFullRequestURL ()
	Return the request URI with the canonical service and hostname, path, and query string.
	getFuzzyBool ($name, $default=false)
	Fetch a boolean value from the input or return $default if not set.
	getHeader ($name)
	Get a request header, or false if it isn't set.
	getInt ($name, $default=0)
	Fetch an integer value from the input or return $default if not set.
	getIntArray ($name, $default=null)
	Fetch an array of integers, or return $default if it's not set.
	getIntOrNull ($name)
	Fetch an integer value from the input or return null if empty.
	getLimitOffset ($deflimit=50, $optionname= 'rclimit')
	Check for limit and offset parameters on the input, and return sensible defaults if not given.
	getMethod ()
	Get the HTTP method used for this request.
	getQueryValues ()
	Get the values passed in the query string.
	getRequestURL ()
	Return the path and query string portion of the request URI.
	getSessionData ($key)
	Get data from $_SESSION.
	getSize ()
	Return the file size of the uploaded file.
	getTempName ()
	Return the path to the temporary file.
	getText ($name, $default= '')
	Fetch a text string from the given array or return $default if it's not set.
	getUpload ($key)
	Return a WebRequestUpload object corresponding to the key.
	getUploadError ($key)
	Return the upload error or 0.
	getVal ($name, $default=null)
	Fetch a scalar from the input or return $default if it's not set.
	getValueNames ($exclude=array())
	Returns the names of all input values excluding those in $exclude.
	getValues ()
	Extracts the given named values into an array.
	interpolateTitle ()
	Check for title, action, and/or variant data in the URL and interpolate it into the GET variables.
	isIniSizeOverflow ()
	Returns whether this upload failed because of overflow of a maximum set in php.ini.
	normalizeUnicode ($data)
	Recursively normalizes UTF-8 strings in the given array.
	response ()
	Return a handle to WebResponse style object, for setting cookies, headers and other stuff, for Request being worked on.
	setSessionData ($key, $data)
	Set session data.
	setVal ($key, $value)
	Set an arbitrary value into our get/post data.
	unsetVal ($key)
	Unset an arbitrary value from our get/post data.
	wasPosted ()
	Returns true if the present request was reached by a POST operation, false otherwise (GET, HEAD, or command-line).
Static Public Member Functions
static	detectProtocol ()
static	detectProtocolAndStdPort ()
static	detectServer ()
	Work out an appropriate URL prefix containing scheme and host, based on information detected from $_SERVER.
static	extractTitle ($path, $bases, $key=false)
	URL rewriting function; tries to extract page title and, optionally, one other fixed parameter value from a URL path.
static	getPathInfo ($want= 'all')
	Extract relevant query arguments from the http request uri's path to be merged with the normal php provided query arguments.
Public Attributes
	$headers = array()
Protected Member Functions
	doSecurityRedirect ($url)
	Attempt to redirect to a URL with a QUERY_STRING that's not dangerous in IE 6.
Protected Attributes
	$data
Private Member Functions
	checkMagicQuotes ()
	If magic_quotes_gpc option is on, run the global arrays through fix_magic_quotes to strip out the stupid slashes.
&	fix_magic_quotes (&$arr, $topLevel=true)
	Recursively strips slashes from the given array; used for undoing the evil that is magic_quotes_gpc.
	getGPCVal ($arr, $name, $default)
	Fetch a value from the given array or return $default if it's not set.
	initHeaders ()
	Initialise the header list.
Private Attributes
String	$ip
	Cached client IP address.
WebResponse	$response
	Lazy-init response object.

Detailed Description

The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form, handling remove of "magic quotes" slashes, stripping illegal input characters and normalizing Unicode sequences.

Usually this is used via a global singleton, $wgRequest. You should not create a second WebRequest object; make a FauxRequest object if you want to pass arbitrary data to some function in place of the web input.

Definition at line 38 of file WebRequest.php.

Constructor & Destructor Documentation

WebRequest::__construct ( )

Definition at line 51 of file WebRequest.php.

References checkMagicQuotes(), and data.

Referenced by DerivativeRequest\__construct().

Member Function Documentation

WebRequest::appendQuery ( $ query )

Take an arbitrary query and rewrite the present URL to include it.

Parameters:

string $query query string fragment; do not include initial '?'

Returns:: String

Definition at line 683 of file WebRequest.php.

WebRequest::appendQueryArray	(	$	array,
		$	onlyquery = `false`
	)

Appends or replaces value of query variables.

Parameters:

array	$array	of values to replace/add to query
bool	$onlyquery	whether to only return the query string and not the complete URL

Returns:: String

Definition at line 716 of file WebRequest.php.

WebRequest::appendQueryValue	(	$	key,
		$	value,
		$	onlyquery = `false`
	)

Parameters:

$key
$value
$onlyquery	bool

Returns:: String

Definition at line 704 of file WebRequest.php.

WebRequest::checkMagicQuotes ( ) [private]

If magic_quotes_gpc option is on, run the global arrays through fix_magic_quotes to strip out the stupid slashes.

WARNING: This should only be done once! Running a second time could damage the values.

Definition at line 291 of file WebRequest.php.

Referenced by __construct().

WebRequest::checkSessionCookie ( )

Returns true if there is a session cookie set.

This does not necessarily mean that the user is logged in!

If you want to check for an open session, use session_id() instead; that will also tell you if the session was opened during the current request (in which case the cookie will be sent back to the client at the end of the script run).

Returns:: Boolean

Reimplemented in DerivativeRequest, and FauxRequest.

Definition at line 603 of file WebRequest.php.

WebRequest::checkUrlExtension ( $ extWhitelist = array() )

Check if Internet Explorer will detect an incorrect cache extension in PATH_INFO or QUERY_STRING.

If the request can't be allowed, show an error message or redirect to a safer URL. Returns true if the URL is OK, and false if an error message has been shown and the request should be aborted.

Parameters:

$extWhitelist array

Exceptions:

HttpError

Returns:: bool

Reimplemented in FauxRequest.

Definition at line 918 of file WebRequest.php.

static WebRequest::detectProtocol ( ) [static]

Returns:: string

Definition at line 206 of file WebRequest.php.

Referenced by LoginForm\execute(), and wfExpandUrl().

static WebRequest::detectProtocolAndStdPort ( ) [static]

Returns:: array

Definition at line 192 of file WebRequest.php.

static WebRequest::detectServer ( ) [static]

Work out an appropriate URL prefix containing scheme and host, based on information detected from $_SERVER.

Returns:: string

Definition at line 160 of file WebRequest.php.

Referenced by WebRequestTest\testDetectServer().

WebRequest::doSecurityRedirect ( $ url ) [protected]

Attempt to redirect to a URL with a QUERY_STRING that's not dangerous in IE 6.

Returns true if it was successful, false otherwise.

Parameters:

$url string

Returns:: bool

Definition at line 943 of file WebRequest.php.

WebRequest::escapeAppendQuery ( $ query )

HTML-safe version of appendQuery().

Deprecated:: : Deprecated in 1.20, warnings in 1.21, remove in 1.22.

Parameters:

string $query query string fragment; do not include initial '?'

Returns:: String

Definition at line 694 of file WebRequest.php.

static WebRequest::extractTitle	(	$	path,
		$	bases,
		$	key = `false`
	)		`[static]`

URL rewriting function; tries to extract page title and, optionally, one other fixed parameter value from a URL path.

Parameters:

string	$path	the URL path given from the client
array	$bases	one or more URLs, optionally with $1 at the end
string	$key	if provided, the matching key in $bases will be passed on as the value of this URL parameter

Returns:: array of URL variables to interpolate; empty if no match

Definition at line 240 of file WebRequest.php.

& WebRequest::fix_magic_quotes	(	&$	arr,
		$	topLevel = `true`
	)		`[private]`

Recursively strips slashes from the given array; used for undoing the evil that is magic_quotes_gpc.

Parameters:

array	$arr	will be modified
bool	$topLevel	Specifies if the array passed is from the top level of the source. In PHP5 magic_quotes only escapes the first level of keys that belong to an array.

Returns:: array the original array

See also:: http://www.php.net/manual/en/function.get-magic-quotes-gpc.php#49612

Definition at line 270 of file WebRequest.php.

WebRequest::getAllHeaders ( )

Get an array containing all request headers.

Returns:: Array mapping header name to its value

Reimplemented in DerivativeRequest.

Definition at line 864 of file WebRequest.php.

WebRequest::getArray	(	$	name,
		$	default = `null`
	)

Fetch an array from the input or return $default if it's not set.

If source was scalar, will return an array with a single element. If no source and no default, returns NULL.

Parameters:

	$name	String
array	$default	optional default (or NULL)

Returns:: Array

Definition at line 413 of file WebRequest.php.

WebRequest::getBool	(	$	name,
		$	default = `false`
	)

Fetch a boolean value from the input or return $default if not set.

Guaranteed to return true or false, with normal PHP semantics for boolean interpretation of strings.

Parameters:

$name	String
$default	Boolean

Returns:: Boolean

Definition at line 477 of file WebRequest.php.

Referenced by FormOptions\fetchValuesFromRequest().

WebRequest::getCheck ( $ name )

Return true if the named value is set in the input, whatever that value is (even "0").

Return false if the named value is not set. Example use is checking for the presence of check boxes in forms.

Parameters:

$name String

Returns:: Boolean

Definition at line 502 of file WebRequest.php.

WebRequest::getCookie	(	$	key,
		$	prefix = `null`,
		$	default = `null`
	)

Get a cookie from the $_COOKIE jar.

Parameters:

string	$key	the name of the cookie
string	$prefix	a prefix to use for the cookie name, if not $wgCookiePrefix
	$default	Mixed: what to return if the value isn't found

Returns:: Mixed: cookie value or $default if the cookie not set

Reimplemented in DerivativeRequest, and FauxRequest.

Definition at line 615 of file WebRequest.php.

WebRequest::getError ( )

Return the upload error.

See link for explanation http://www.php.net/manual/en/features.file-upload.errors.php

Returns:: int One of the UPLOAD_ constants, 0 if non-existent

Definition at line 1220 of file WebRequest.php.

WebRequest::getFileName ( $ key )

Return the original filename of the uploaded file, as reported by the submitting user agent.

HTML-style character entities are interpreted and normalized to Unicode normalization form C, in part to deal with weird input from Safari with non-ASCII filenames.

Other than this the name is not verified for being a safe filename.

Parameters:

$key String:

Returns:: string or NULL if no such file.

Definition at line 805 of file WebRequest.php.

WebRequest::getFileSize ( $ key )

Return the size of the upload, or 0.

Deprecated:: since 1.17

Parameters:

$key String:

Returns:: integer

Definition at line 777 of file WebRequest.php.

WebRequest::getFileTempname ( $ key )

Return the path to the temporary file where PHP has stored the upload.

Parameters:

$key String:

Returns:: string or NULL if no such file.

Definition at line 765 of file WebRequest.php.

WebRequest::getFullRequestURL ( )

Return the request URI with the canonical service and hostname, path, and query string.

This will be suitable for use as an absolute link in HTML or other output.

If $wgServer is protocol-relative, this will return a fully qualified URL with the protocol that was used for this request.

Returns:: String

Definition at line 673 of file WebRequest.php.

WebRequest::getFuzzyBool	(	$	name,
		$	default = `false`
	)

Fetch a boolean value from the input or return $default if not set.

Unlike getBool, the string "false" will result in boolean false, which is useful when interpreting information sent from JavaScript.

Parameters:

$name	String
$default	Boolean

Returns:: Boolean

Definition at line 490 of file WebRequest.php.

Referenced by ResourceLoaderContext\__construct().

WebRequest::getGPCVal	(	$	arr,
		$	name,
		$	default
	)		`[private]`

Fetch a value from the given array or return $default if it's not set.

Parameters:

$arr	Array
$name	String
$default	Mixed

Returns:: mixed

Definition at line 331 of file WebRequest.php.

WebRequest::getHeader ( $ name )

Get a request header, or false if it isn't set.

Parameters:

string $name case-insensitive header name

Returns:: string|bool False on failure

Reimplemented in DerivativeRequest, and FauxRequest.

Definition at line 875 of file WebRequest.php.

WebRequest::getInt	(	$	name,
		$	default = `0`
	)

Fetch an integer value from the input or return $default if not set.

Guaranteed to return an integer; non-numeric input will typically return 0.

Parameters:

$name	String
$default	Integer

Returns:: Integer

Definition at line 449 of file WebRequest.php.

Referenced by FormOptions\fetchValuesFromRequest().

WebRequest::getIntArray	(	$	name,
		$	default = `null`
	)

Fetch an array of integers, or return $default if it's not set.

If source was scalar, will return an array with a single element. If no source and no default, returns NULL. If an array is returned, contents are guaranteed to be integers.

Parameters:

	$name	String
array	$default	option default (or NULL)

Returns:: Array of ints

Definition at line 432 of file WebRequest.php.

WebRequest::getIntOrNull ( $ name )

Fetch an integer value from the input or return null if empty.

Guaranteed to return an integer or null; non-numeric input will typically return null.

Parameters:

$name String

Returns:: Integer

Definition at line 461 of file WebRequest.php.

Referenced by FormOptions\fetchValuesFromRequest().

WebRequest::getLimitOffset	(	$	deflimit = `50`,
		$	optionname = `'rclimit'`
	)

Check for limit and offset parameters on the input, and return sensible defaults if not given.

The limit must be positive and is capped at 5000. Offset must be positive but is not capped.

Parameters:

	$deflimit	Integer: limit to use if no input and the user hasn't set the option.
string	$optionname	to specify an option other than rclimit to pull from.

Returns:: array first element is limit, second is offset

Definition at line 734 of file WebRequest.php.

WebRequest::getMethod ( )

Get the HTTP method used for this request.

Returns:: String

Reimplemented in FauxRequest.

Definition at line 575 of file WebRequest.php.

static WebRequest::getPathInfo ( $ want = 'all' ) [static]

Extract relevant query arguments from the http request uri's path to be merged with the normal php provided query arguments.

Tries to use the REQUEST_URI data if available and parses it according to the wiki's configuration looking for any known pattern.

If the REQUEST_URI is not provided we'll fall back on the PATH_INFO provided by the server if any and use that to set a 'title' parameter.

Parameters:

string $want If this is not 'all', then the function will return an empty array if it determines that the URL is inside a rewrite path.

Returns:: Array: Any query arguments found in path matches.

Definition at line 77 of file WebRequest.php.

WebRequest::getQueryValues ( )

Get the values passed in the query string.

No transformation is performed on the values.

Returns:: Array

Reimplemented in FauxRequest.

Definition at line 566 of file WebRequest.php.

WebRequest::getRequestURL ( )

Return the path and query string portion of the request URI.

This will be suitable for use as a relative link in HTML output.

Exceptions:

MWException

Returns:: String

Reimplemented in FauxRequest.

Definition at line 630 of file WebRequest.php.

WebRequest::getSessionData ( $ key )

Get data from $_SESSION.

Parameters:

string $key name of key in $_SESSION

Returns:: Mixed

Reimplemented in DerivativeRequest, and FauxRequest.

Definition at line 891 of file WebRequest.php.

WebRequest::getSize ( )

Return the file size of the uploaded file.

Returns:: int File size or zero if non-existent

Definition at line 1193 of file WebRequest.php.

WebRequest::getTempName ( )

Return the path to the temporary file.

Returns:: mixed Path or null if non-existent

Definition at line 1206 of file WebRequest.php.

WebRequest::getText	(	$	name,
		$	default = `''`
	)

Fetch a text string from the given array or return $default if it's not set.

Carriage returns are stripped from the text, and with some language modules there is an input transliteration applied. This should generally be used for form "<textarea>" and "<input>" fields. Used for user-supplied freeform text input (for which input transformations may be required - e.g. Esperanto x-coding).

Parameters:

	$name	String
string	$default	optional

Returns:: String

Reimplemented in FauxRequest.

Definition at line 520 of file WebRequest.php.

Referenced by FormOptions\fetchValuesFromRequest().

WebRequest::getUpload ( $ key )

Return a WebRequestUpload object corresponding to the key.

Parameters:

$key string

Returns:: WebRequestUpload

Definition at line 816 of file WebRequest.php.

WebRequest::getUploadError ( $ key )

Return the upload error or 0.

Parameters:

$key String:

Returns:: integer

Definition at line 789 of file WebRequest.php.

WebRequest::getVal	(	$	name,
		$	default = `null`
	)

Fetch a scalar from the input or return $default if it's not set.

Returns a string. Arrays are discarded. Useful for non-freeform text inputs (e.g. predefined internal text keys selected by a drop-down menu). For freeform input, see getText().

Parameters:

	$name	String
string	$default	optional default (or NULL)

Returns:: String

Definition at line 363 of file WebRequest.php.

Referenced by ResourceLoaderContext\__construct().

WebRequest::getValueNames ( $ exclude = array() )

Returns the names of all input values excluding those in $exclude.

Parameters:

$exclude Array

Returns:: array

Definition at line 556 of file WebRequest.php.

WebRequest::getValues ( )

Extracts the given named values into an array.

If no arguments are given, returns all input values. No transformation is performed on the values.

Returns:: array

Reimplemented in FauxRequest.

Definition at line 534 of file WebRequest.php.

WebRequest::initHeaders ( ) [private]

Initialise the header list.

Definition at line 838 of file WebRequest.php.

WebRequest::interpolateTitle ( )

Check for title, action, and/or variant data in the URL and interpolate it into the GET variables.

This should only be run after $wgContLang is available, as we may need the list of language variants to determine available variant URLs.

Definition at line 218 of file WebRequest.php.

WebRequest::isIniSizeOverflow ( )

Returns whether this upload failed because of overflow of a maximum set in php.ini.

Returns:: bool

Definition at line 1234 of file WebRequest.php.

WebRequest::normalizeUnicode ( $ data )

Recursively normalizes UTF-8 strings in the given array.

Parameters:

$data string|array

Returns:: array|string cleaned-up version of the given

Access:: private

Definition at line 311 of file WebRequest.php.

WebRequest::response ( )

Return a handle to WebResponse style object, for setting cookies, headers and other stuff, for Request being worked on.

Returns:: WebResponse

Definition at line 826 of file WebRequest.php.

WebRequest::setSessionData	(	$	key,
		$	data
	)

Set session data.

Parameters:

string	$key	name of key in $_SESSION
	$data	Mixed

Reimplemented in DerivativeRequest, and FauxRequest.

Definition at line 904 of file WebRequest.php.

WebRequest::setVal	(	$	key,
		$	value
	)

Set an arbitrary value into our get/post data.

Parameters:

string	$key	key name to use
	$value	Mixed: value to set

Returns:: Mixed: old value if one was present, null otherwise

Definition at line 382 of file WebRequest.php.

WebRequest::unsetVal ( $ key )

Unset an arbitrary value from our get/post data.

Parameters:

string $key key name to use

Returns:: Mixed: old value if one was present, null otherwise

Definition at line 394 of file WebRequest.php.

WebRequest::wasPosted ( )

Returns true if the present request was reached by a POST operation, false otherwise (GET, HEAD, or command-line).

Note that values retrieved by the object may come from the GET URL etc even on a POST request.

Returns:: Boolean

Reimplemented in FauxRequest.

Definition at line 588 of file WebRequest.php.

Member Data Documentation

WebRequest::$data [protected]

Definition at line 39 of file WebRequest.php.

Referenced by DerivativeRequest\__construct().

WebRequest::$headers = array()

Definition at line 39 of file WebRequest.php.

String WebRequest::$ip [private]

Cached client IP address.

Definition at line 49 of file WebRequest.php.

WebResponse WebRequest::$response [private]

Lazy-init response object.

Definition at line 44 of file WebRequest.php.

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

includes/WebRequest.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation