MediaWiki  REL1_22
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 ()
 getRawInput ()
 FauxRequests shouldn't depend on raw request data (but that could be implemented here)
 getRawPostString ()
 FauxRequests shouldn't depend on raw request data (but that could be implemented here)
 getRawQueryString ()
 FauxRequests shouldn't depend on raw request data (but that could be implemented here)
 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 1304 of file WebRequest.php.


Constructor & Destructor Documentation

FauxRequest::__construct ( data = array(),
wasPosted = false,
session = null 
)
Parameters:
array$dataof *non*-urlencoded key => value pairs, the fake GET/POST values
bool$wasPostedwhether to treat the data as POST
$sessionMixed: session array or null
Exceptions:
MWException

Definition at line 1315 of file WebRequest.php.


Member Function Documentation

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

FauxRequest::checkUrlExtension ( extWhitelist = array())
Parameters:
array$extWhitelist
Returns:
bool

Reimplemented from WebRequest.

Definition at line 1466 of file WebRequest.php.

FauxRequest::getCookie ( key,
prefix = null,
default = null 
)

Get a cookie from the $_COOKIE jar.

Parameters:
string$keythe name of the cookie
string$prefixa prefix to use for the cookie name, if not $wgCookiePrefix
$defaultMixed: 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 1374 of file WebRequest.php.

Parameters:
string$nameThe name of the header to get (case insensitive).
Returns:
bool|string

Reimplemented from WebRequest.

Reimplemented in DerivativeRequest.

Definition at line 1390 of file WebRequest.php.

Get the HTTP method used for this request.

Returns:
String

Reimplemented from WebRequest.

Definition at line 1363 of file WebRequest.php.

Returns:
array

Reimplemented from WebRequest.

Definition at line 1355 of file WebRequest.php.

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

Returns:
String

Reimplemented from WebRequest.

Definition at line 1458 of file WebRequest.php.

FauxRequest::getRawIP ( ) [protected]
Returns:
string

Definition at line 1473 of file WebRequest.php.

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

Returns:
String

Reimplemented from WebRequest.

Definition at line 1450 of file WebRequest.php.

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

Returns:
String

Reimplemented from WebRequest.

Definition at line 1442 of file WebRequest.php.

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

Returns:
array|Mixed|null

Definition at line 1426 of file WebRequest.php.

Parameters:
$key
Returns:
mixed

Reimplemented from WebRequest.

Reimplemented in DerivativeRequest.

Definition at line 1408 of file WebRequest.php.

FauxRequest::getText ( name,
default = '' 
)
Parameters:
$namestring
$defaultstring
Returns:
string

Reimplemented from WebRequest.

Definition at line 1340 of file WebRequest.php.

Returns:
Array

Reimplemented from WebRequest.

Definition at line 1348 of file WebRequest.php.

FauxRequest::isPathInfoBad ( extWhitelist = array())
Parameters:
array$extWhitelist
Returns:
bool

Definition at line 1434 of file WebRequest.php.

FauxRequest::notImplemented ( method) [private]
Parameters:
$methodstring
Exceptions:
MWException

Definition at line 1331 of file WebRequest.php.

FauxRequest::setHeader ( name,
val 
)
Parameters:
$namestring
$valstring

Definition at line 1399 of file WebRequest.php.

FauxRequest::setSessionData ( key,
data 
)
Parameters:
$key
$data

Reimplemented from WebRequest.

Reimplemented in DerivativeRequest.

Definition at line 1419 of file WebRequest.php.

Returns:
bool

Reimplemented from WebRequest.

Definition at line 1370 of file WebRequest.php.


Member Data Documentation

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

Definition at line 1306 of file WebRequest.php.

FauxRequest::$wasPosted = false [private]

Definition at line 1305 of file WebRequest.php.

Referenced by DerivativeRequest\__construct().


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