FauxRequest Class Reference

WebRequest clone which takes values from a provided array. More...

Inheritance diagram for FauxRequest:

Collaboration diagram for FauxRequest:

List of all members.

Public Member Functions
	__construct ($data=array(), $wasPosted=false, $session=null)
	checkSessionCookie ()
	Returns true if there is a session cookie set.
	checkUrlExtension ($extWhitelist=array())
	getCookie ($key, $prefix=null, $default=null)
	Get a cookie from the $_COOKIE jar.
	getHeader ($name)
	getMethod ()
	Get the HTTP method used for this request.
	getQueryValues ()
	getRequestURL ()
	Return the path and query string portion of the request URI.
	getSessionArray ()
	getSessionData ($key)
	getText ($name, $default= '')
	getValues ()
	isPathInfoBad ($extWhitelist=array())
	setHeader ($name, $val)
	setSessionData ($key, $data)
	wasPosted ()
Protected Member Functions
	getRawIP ()
Private Member Functions
	notImplemented ($method)
Private Attributes
	$session = array()
	$wasPosted = false

---

Detailed Description

WebRequest clone which takes values from a provided array.

Definition at line 1255 of file WebRequest.php.

---

Constructor & Destructor Documentation

FauxRequest::__construct	(	$	data = array(),
		$	wasPosted = false,
		$	session = null
	)

Parameters:

array	$data	of *non*-urlencoded key => value pairs, the fake GET/POST values
bool	$wasPosted	whether to treat the data as POST
	$session	Mixed: session array or null

Exceptions:

MWException

Definition at line 1266 of file WebRequest.php.

---

Member Function Documentation

FauxRequest::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 WebRequest.

Reimplemented in DerivativeRequest.

Definition at line 1329 of file WebRequest.php.

FauxRequest::checkUrlExtension

(

$

extWhitelist = array()

)

Parameters:

array

$extWhitelist

Returns:

bool

Reimplemented from WebRequest.

Definition at line 1391 of file WebRequest.php.

FauxRequest::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 WebRequest.

Reimplemented in DerivativeRequest.

Definition at line 1325 of file WebRequest.php.

FauxRequest::getHeader

(

$

name

)

Parameters:

$name

Returns:

bool|string

Reimplemented from WebRequest.

Reimplemented in DerivativeRequest.

Definition at line 1341 of file WebRequest.php.

FauxRequest::getMethod

(

)

Get the HTTP method used for this request.

Returns:

String

Reimplemented from WebRequest.

Definition at line 1314 of file WebRequest.php.

FauxRequest::getQueryValues

(

)

Returns:

array

Reimplemented from WebRequest.

Definition at line 1306 of file WebRequest.php.

FauxRequest::getRawIP

(

)

[protected]

Returns:

string

Definition at line 1398 of file WebRequest.php.

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

Definition at line 1333 of file WebRequest.php.

FauxRequest::getSessionArray

(

)

Returns:

array|Mixed|null

Definition at line 1375 of file WebRequest.php.

FauxRequest::getSessionData

(

$

key

)

Parameters:

$key

Returns:

mixed

Reimplemented from WebRequest.

Reimplemented in DerivativeRequest.

Definition at line 1357 of file WebRequest.php.

FauxRequest::getText	(	$	name,
		$	default = ''
	)

Parameters:

$name	string
$default	string

Returns:

string

Reimplemented from WebRequest.

Definition at line 1291 of file WebRequest.php.

FauxRequest::getValues

(

)

Returns:

Array

Reimplemented from WebRequest.

Definition at line 1299 of file WebRequest.php.

FauxRequest::isPathInfoBad

(

$

extWhitelist = array()

)

Parameters:

array

$extWhitelist

Returns:

bool

Definition at line 1383 of file WebRequest.php.

FauxRequest::notImplemented

(

$

method

)

[private]

Parameters:

$method

string

Exceptions:

MWException

Definition at line 1282 of file WebRequest.php.

FauxRequest::setHeader	(	$	name,
		$	val
	)

Parameters:

$name	string
$val	string

Definition at line 1349 of file WebRequest.php.

FauxRequest::setSessionData	(	$	key,
		$	data
	)

Parameters:

$key
$data

Reimplemented from WebRequest.

Reimplemented in DerivativeRequest.

Definition at line 1368 of file WebRequest.php.

FauxRequest::wasPosted

(

)

Returns:

bool

Reimplemented from WebRequest.

Definition at line 1321 of file WebRequest.php.

---

Member Data Documentation

FauxRequest::$session = array() [private]

Definition at line 1257 of file WebRequest.php.

FauxRequest::$wasPosted = false [private]

Definition at line 1256 of file WebRequest.php.

Referenced by DerivativeRequest\__construct().

---

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

• includes/WebRequest.php