MediaWiki\Request\FauxResponse Class Reference

Inherits MediaWiki\Request\WebResponse.

Collaboration diagram for MediaWiki\Request\FauxResponse:

Public Member Functions
	getCookie ( $name)
	getCookieData ( $name)
	getCookies ()
	getHeader ( $key)
	getStatusCode ()
	Get the HTTP response code, null if not set.
	hasCookies ()
	Checks whether this request is performing cookie operations. Returns bool Since 1.27
	header ( $string, $replace=true, $http_response_code=null)
	Stores a HTTP header.
	headersSent ()
	Test if headers have been sent.
	setCookie ( $name, $value, $expire=0, $options=[])
	setCookieConfig (Config $cookieConfig)
	statusHeader ( $code)
Public Member Functions inherited from MediaWiki\Request\WebResponse
	clearCookie ( $name, $options=[])
	Unset a browser cookie.
	disableForPostSend ()
	Disable setters for post-send processing.

Additional Inherited Members
Protected Attributes inherited from MediaWiki\Request\WebResponse
bool	$disableForPostSend = false
	Used to disable setters before running jobs post-request (T191537)
Static Protected Attributes inherited from MediaWiki\Request\WebResponse
static array	$setCookies = []
	Used to record set cookies, because PHP's setcookie() will happily send an identical Set-Cookie to the client.

Detailed Description

Definition at line 33 of file FauxResponse.php.

Member Function Documentation

getCookie()

MediaWiki\Request\FauxResponse::getCookie

(

$name

)

Parameters

string

$name

Returns

string|null

Definition at line 171 of file FauxResponse.php.

getCookieData()

MediaWiki\Request\FauxResponse::getCookieData

(

$name

)

Parameters

string

$name

Returns

array|null

Definition at line 182 of file FauxResponse.php.

getCookies()

MediaWiki\Request\FauxResponse::getCookies

(

)

Returns

array[]

Definition at line 189 of file FauxResponse.php.

getHeader()

MediaWiki\Request\FauxResponse::getHeader

(

$key

)

Parameters

string

$key

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

Returns

string|null The header value (if set); null otherwise.

Reimplemented from MediaWiki\Request\WebResponse.

Definition at line 89 of file FauxResponse.php.

getStatusCode()

MediaWiki\Request\FauxResponse::getStatusCode

(

)

Get the HTTP response code, null if not set.

Returns

int|null

Reimplemented from MediaWiki\Request\WebResponse.

Definition at line 100 of file FauxResponse.php.

hasCookies()

MediaWiki\Request\FauxResponse::hasCookies

(

)

Checks whether this request is performing cookie operations.

Returns

bool

Since

1.27

Reimplemented from MediaWiki\Request\WebResponse.

Definition at line 196 of file FauxResponse.php.

header()

MediaWiki\Request\FauxResponse::header	(		$string,
			$replace = true,
			$http_response_code = null )

Stores a HTTP header.

Parameters

string	$string	Header to output
bool	$replace	Replace current similar header
null | int	$http_response_code	Forces the HTTP response code to the specified value.

Reimplemented from MediaWiki\Request\WebResponse.

Definition at line 50 of file FauxResponse.php.

References MediaWiki\Request\WebResponse\disableForPostSend().

headersSent()

MediaWiki\Request\FauxResponse::headersSent

(

)

Test if headers have been sent.

Since

1.27

Returns

bool

Reimplemented from MediaWiki\Request\WebResponse.

Definition at line 81 of file FauxResponse.php.

setCookie()

MediaWiki\Request\FauxResponse::setCookie	(		$name,
			$value,
			$expire = 0,
			$options = [] )

Parameters

string	$name	The name of the cookie.
string	$value	The value to be stored in the cookie.
int | null	$expire	Ignored in this faux subclass.
array	$options	Ignored in this faux subclass.

Reimplemented from MediaWiki\Request\WebResponse.

Definition at line 127 of file FauxResponse.php.

References MediaWiki\Config\Config\get().

setCookieConfig()

MediaWiki\Request\FauxResponse::setCookieConfig

(

Config

$cookieConfig

)

Parameters

Config

$cookieConfig

Definition at line 117 of file FauxResponse.php.

statusHeader()

MediaWiki\Request\FauxResponse::statusHeader

(

$code

)

Since

1.26

Parameters

int

$code

Status code

Reimplemented from MediaWiki\Request\WebResponse.

Definition at line 77 of file FauxResponse.php.

---

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

• includes/Request/FauxResponse.php