DerivativeRequest Class Reference

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:

Collaboration diagram for DerivativeRequest:

List of all members.

Public Member Functions
	__construct (WebRequest $base, $data, $wasPosted=false)
	checkSessionCookie ()
	Returns true if there is a session cookie set.
	getAcceptLang ()
	getAllHeaders ()
	Get an array containing all request headers.
	getCookie ($key, $prefix=null, $default=null)
	Get a cookie from the $_COOKIE jar.
	getHeader ($name)
	getIP ()
	getProtocol ()
	Get the current URL protocol (http or https)
	getSessionData ($key)
	setSessionData ($key, $data)
Private Attributes
	$base

---

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 1472 of file WebRequest.php.

---

Constructor & Destructor Documentation

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 1481 of file WebRequest.php.

---

Member Function Documentation

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 1490 of file WebRequest.php.

DerivativeRequest::getAcceptLang

(

)

Definition at line 1510 of file WebRequest.php.

DerivativeRequest::getAllHeaders

(

)

Get an array containing all request headers.

Returns:

Array mapping header name to its value

Reimplemented from WebRequest.

Definition at line 1498 of file WebRequest.php.

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 1486 of file WebRequest.php.

DerivativeRequest::getHeader

(

$

name

)

Parameters:

string

$name

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

Returns:

bool|string

Reimplemented from FauxRequest.

Definition at line 1494 of file WebRequest.php.

DerivativeRequest::getIP

(

)

Definition at line 1514 of file WebRequest.php.

DerivativeRequest::getProtocol

(

)

Get the current URL protocol (http or https)

Returns:

string

Reimplemented from FauxRequest.

Definition at line 1518 of file WebRequest.php.

DerivativeRequest::getSessionData

(

$

key

)

Parameters:

$key

Returns:

mixed

Reimplemented from FauxRequest.

Definition at line 1502 of file WebRequest.php.

DerivativeRequest::setSessionData	(	$	key,
		$	data
	)

Parameters:

$key
$data

Reimplemented from FauxRequest.

Definition at line 1506 of file WebRequest.php.

---

Member Data Documentation

DerivativeRequest::$base [private]

Definition at line 1473 of file WebRequest.php.

---

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

• includes/WebRequest.php