FauxResponse Class Reference

Inheritance diagram for FauxResponse:

Collaboration diagram for FauxResponse:

Public Member Functions
	getCookie ( $name)
	getCookieData ( $name)
	getCookies ()
	getHeader ( $key)
	getStatusCode ()
	Get the HTTP response code, null if not set.
	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=[])
	statusHeader ( $code)
Public Member Functions inherited from WebResponse
	clearCookie ( $name, $options=[])
	Unset a browser cookie.
	hasCookies ()
	Checks whether this request is performing cookie operations.

Private Attributes
	$code
	$cookies = []
	$headers

Additional Inherited Members
Static Public Member Functions inherited from WebResponse
static	disableForPostSend ()
	Disable setters for post-send processing.
Static Protected Attributes inherited from WebResponse
static bool	$disableForPostSend = false
	Used to disable setters before running jobs post-request (T191537)
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 26 of file FauxResponse.php.

Member Function Documentation

getCookie()

FauxResponse::getCookie

(

$name

)

Parameters

string

$name

Returns

string|null

Definition at line 129 of file FauxResponse.php.

getCookieData()

FauxResponse::getCookieData

(

$name

)

Parameters

string

$name

Returns

array|null

Definition at line 140 of file FauxResponse.php.

getCookies()

FauxResponse::getCookies

(

)

Returns

array

Definition at line 147 of file FauxResponse.php.

References $cookies.

getHeader()

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

Definition at line 72 of file FauxResponse.php.

getStatusCode()

FauxResponse::getStatusCode

(

)

Get the HTTP response code, null if not set.

Returns

int|null

Definition at line 83 of file FauxResponse.php.

References $code.

header()

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

Definition at line 37 of file FauxResponse.php.

headersSent()

FauxResponse::headersSent

(

)

Test if headers have been sent.

Since

1.27

Returns

bool

Reimplemented from WebResponse.

Definition at line 64 of file FauxResponse.php.

setCookie()

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

Definition at line 93 of file FauxResponse.php.

References $wgCookieDomain, $wgCookieExpiration, $wgCookieHttpOnly, $wgCookiePath, $wgCookiePrefix, and $wgCookieSecure.

statusHeader()

FauxResponse::statusHeader

(

$code

)

Since

1.26

Parameters

int

$code

Status code

Reimplemented from WebResponse.

Definition at line 60 of file FauxResponse.php.

References $code.

Member Data Documentation

$code

FauxResponse::$code

private

Definition at line 29 of file FauxResponse.php.

Referenced by getStatusCode(), and statusHeader().

$cookies

FauxResponse::$cookies = []

private

Definition at line 28 of file FauxResponse.php.

Referenced by getCookies().

$headers

FauxResponse::$headers

private

Definition at line 27 of file FauxResponse.php.

---

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

• includes/FauxResponse.php