Similar to FauxRequest, but only fakes URL parameters and method (POST or GET) and use the base request for the remaining stuff (cookies, session and headers). More...

Inheritance diagram for DerivativeRequest:

[legend]

Collaboration diagram for DerivativeRequest:

[legend]

Public Member Functions
	__construct (WebRequest $base, $data, $wasPosted=false)

	checkSessionCookie ()
	Returns true if there is a session cookie set. More...

	getAcceptLang ()
	Parse the Accept-Language header sent by the client into an array. More...

	getAllHeaders ()
	Get an array containing all request headers. More...

	getCookie ( $key, $prefix=null, $default=null)
	Get a cookie from the $_COOKIE jar. More...

	getHeader ( $name)

	getIP ()
	Work out the IP address based on various globals For trusted proxies, use the XFF client IP (first of the chain) More...

	getProtocol ()
	Get the current URL protocol (http or https) More...

	getSessionData ( $key)

	setSessionData ( $key, $data)

Public Member Functions inherited from FauxRequest
	__construct ( $data=array(), $wasPosted=false, $session=null, $protocol='http')

	checkUrlExtension ( $extWhitelist=array())

	getMethod ()
	Get the HTTP method used for this request. More...

	getQueryValues ()

	getRawInput ()
	FauxRequests shouldn't depend on raw request data (but that could be implemented here) More...

	getRawPostString ()
	FauxRequests shouldn't depend on raw request data (but that could be implemented here) More...

	getRawQueryString ()
	FauxRequests shouldn't depend on raw request data (but that could be implemented here) More...

	getRequestURL ()
	Return the path and query string portion of the request URI. More...

	getSessionArray ()

	getText ( $name, $default='')

	getValues ()

	setHeader ( $name, $val)

	wasPosted ()

Public Member Functions inherited from WebRequest
	__construct ()

	appendQuery ( $query)
	Take an arbitrary query and rewrite the present URL to include it. More...

	appendQueryArray ( $array, $onlyquery=false)
	Appends or replaces value of query variables. More...

	appendQueryValue ( $key, $value, $onlyquery=false)

	escapeAppendQuery ( $query)
	HTML-safe version of appendQuery(). More...

	getArray ( $name, $default=null)
	Fetch an array from the input or return $default if it's not set. More...

	getBool ( $name, $default=false)
	Fetch a boolean value from the input or return $default if not set. More...

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

	getFileName ( $key)
	Return the original filename of the uploaded file, as reported by the submitting user agent. More...

	getFileTempname ( $key)
	Return the path to the temporary file where PHP has stored the upload. More...

	getFloat ( $name, $default=0)
	Fetch a floating point value from the input or return $default if not set. More...

	getFullRequestURL ()
	Return the request URI with the canonical service and hostname, path, and query string. More...

	getFuzzyBool ( $name, $default=false)
	Fetch a boolean value from the input or return $default if not set. More...

	getInt ( $name, $default=0)
	Fetch an integer value from the input or return $default if not set. More...

	getIntArray ( $name, $default=null)
	Fetch an array of integers, or return $default if it's not set. More...

	getIntOrNull ( $name)
	Fetch an integer value from the input or return null if empty. More...

	getLimitOffset ( $deflimit=50, $optionname='rclimit')
	Check for limit and offset parameters on the input, and return sensible defaults if not given. More...

	getUpload ( $key)
	Return a WebRequestUpload object corresponding to the key. More...

	getUploadError ( $key)
	Return the upload error or 0. More...

	getVal ( $name, $default=null)
	Fetch a scalar from the input or return $default if it's not set. More...

	getValueNames ( $exclude=array())
	Returns the names of all input values excluding those in $exclude. More...

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

	normalizeUnicode ( $data)
	Recursively normalizes UTF-8 strings in the given array. More...

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

	setIP ( $ip)

	setVal ( $key, $value)
	Set an arbitrary value into our get/post data. More...

	unsetVal ( $key)
	Unset an arbitrary value from our get/post data. More...

Private Attributes
	$base

Additional Inherited Members
Static Public Member Functions inherited from WebRequest
static	detectProtocol ()
	Detect the protocol from $_SERVER. More...

static	detectServer ()
	Work out an appropriate URL prefix containing scheme and host, based on information detected from $_SERVER. More...

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. More...

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. More...

Public Attributes inherited from WebRequest
	$headers = array()

Protected Member Functions inherited from FauxRequest
	getRawIP ()

Protected Member Functions inherited from WebRequest
	doSecurityRedirect ( $url)
	Attempt to redirect to a URL with a QUERY_STRING that's not dangerous in IE 6. More...

Protected Attributes inherited from WebRequest
	$data

string	$protocol
	Cached URL protocol. More...

Detailed Description

Similar to FauxRequest, but only fakes URL parameters and method (POST or GET) and use the base request for the remaining stuff (cookies, session and headers).

Since: 1.19

Definition at line 1455 of file WebRequest.php.

Constructor & Destructor Documentation

◆ __construct()

DerivativeRequest::__construct	(	WebRequest	$base,
			$data,
			$wasPosted = `false`
	)

Parameters

WebRequest	$base
array	$data	Array of non-urlencoded key => value pairs, the fake GET/POST values
bool	$wasPosted	Whether to treat the data as POST

Definition at line 1464 of file WebRequest.php.

Member Function Documentation

◆ checkSessionCookie()

DerivativeRequest::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 from FauxRequest.

Definition at line 1473 of file WebRequest.php.

◆ getAcceptLang()

DerivativeRequest::getAcceptLang ( )

Parse the Accept-Language header sent by the client into an array.

Returns: array array( languageCode => q-value ) sorted by q-value in descending order then appearing time in the header in ascending order. May contain the "language" '*', which applies to languages other than those explicitly listed. This is aligned with rfc2616 section 14.4 Preference for earlier languages appears in rfc3282 as an extension to HTTP/1.1.

Reimplemented from WebRequest.

Definition at line 1493 of file WebRequest.php.

References $name.

◆ getAllHeaders()

DerivativeRequest::getAllHeaders ( )

Get an array containing all request headers.

Returns: Array mapping header name to its value

Reimplemented from WebRequest.

Definition at line 1481 of file WebRequest.php.

References $base, WebRequest\$data, and FauxRequest\$wasPosted.

◆ getCookie()

DerivativeRequest::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 from FauxRequest.

Definition at line 1469 of file WebRequest.php.

◆ getHeader()

DerivativeRequest::getHeader ( $name )

Parameters

string $name The name of the header to get (case insensitive).

Returns: bool|string

Reimplemented from FauxRequest.

Definition at line 1477 of file WebRequest.php.

◆ getIP()

DerivativeRequest::getIP ( )

Work out the IP address based on various globals For trusted proxies, use the XFF client IP (first of the chain)

Since: 1.19

Exceptions

MWException

Returns: string

Reimplemented from WebRequest.

Definition at line 1497 of file WebRequest.php.

◆ getProtocol()

DerivativeRequest::getProtocol ( )

Get the current URL protocol (http or https)

Returns: string

Reimplemented from FauxRequest.

Definition at line 1501 of file WebRequest.php.

◆ getSessionData()

DerivativeRequest::getSessionData ( $key )

Parameters

$key

Returns: mixed

Reimplemented from FauxRequest.

Definition at line 1485 of file WebRequest.php.

◆ setSessionData()

DerivativeRequest::setSessionData	(	$key,
		$data
	)

Parameters

$key
$data

Reimplemented from FauxRequest.

Definition at line 1489 of file WebRequest.php.

Member Data Documentation

◆ $base

DerivativeRequest::$base

private

Definition at line 1456 of file WebRequest.php.

Referenced by getAllHeaders().

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

includes/WebRequest.php

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkSessionCookie()

◆ getAcceptLang()

◆ getAllHeaders()

◆ getCookie()

◆ getHeader()

◆ getIP()

◆ getProtocol()

◆ getSessionData()

◆ setSessionData()

Member Data Documentation

◆ $base