This is a request class that gets data directly from the superglobals and other global PHP state, notably php://input. More...

Inheritance diagram for MediaWiki\Rest\RequestFromGlobals:

[legend]

Collaboration diagram for MediaWiki\Rest\RequestFromGlobals:

[legend]

Public Member Functions
	__construct ( $params=[])

	getBody ()
	Gets the body of the message.

	getCookieParams ()
	Retrieve cookies.

	getMethod ()
	Retrieves the HTTP method of the request.

	getPostParams ()
	Retrieve POST form parameters.

	getProtocolVersion ()
	Retrieves the HTTP protocol version as a string.

	getQueryParams ()
	Retrieve query string arguments.

	getServerParams ()
	Retrieve server parameters.

	getUploadedFiles ()
	Retrieve normalized file upload data.

	getUri ()
	Retrieves the URI instance.

Public Member Functions inherited from MediaWiki\Rest\RequestBase
	__clone ()

	getCookie ( $name, $default=null)
	Add the cookie prefix to a specified cookie name and get the value of the resulting prefixed cookie.

	getCookiePrefix ()
	Get the current cookie prefix.

	getHeader ( $name)
	Retrieves a message header value by the given case-insensitive name.

	getHeaderLine ( $name)
	Retrieves a comma-separated string of the values for a single header.

	getHeaders ()
	Retrieves all message header values.

	getPathParam ( $name)
	Retrieve a single path parameter.

	getPathParams ()
	Get the parameters derived from the path template match.

	hasHeader ( $name)
	Checks if a header exists by the given case-insensitive name.

	setPathParams ( $params)
	Erase all path parameters from the object and set the parameter array to the one specified.

Protected Member Functions
	initHeaders ()
	Override this in the implementation class if lazy initialisation of header values is desired.

Protected Member Functions inherited from MediaWiki\Rest\RequestBase
	setHeaders ( $headers)
	Erase any existing headers and replace them with the specified header lines.

Detailed Description

This is a request class that gets data directly from the superglobals and other global PHP state, notably php://input.

Definition at line 15 of file RequestFromGlobals.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\RequestFromGlobals::__construct ( $params = [] )

Parameters

array

$params

Associative array of parameters:

cookiePrefix: The prefix for cookie names used by getCookie()

Reimplemented from MediaWiki\Rest\RequestBase.

Definition at line 24 of file RequestFromGlobals.php.

Member Function Documentation

◆ getBody()

MediaWiki\Rest\RequestFromGlobals::getBody ( )

Gets the body of the message.

Returns: StreamInterface Returns the body as a stream.

Implements MediaWiki\Rest\RequestInterface.

Definition at line 76 of file RequestFromGlobals.php.

◆ getCookieParams()

MediaWiki\Rest\RequestFromGlobals::getCookieParams ( )

Retrieve cookies.

Retrieves cookies sent by the client to the server.

The data MUST be compatible with the structure of the $_COOKIE superglobal.

Returns: array

Implements MediaWiki\Rest\RequestInterface.

Definition at line 86 of file RequestFromGlobals.php.

◆ getMethod()

MediaWiki\Rest\RequestFromGlobals::getMethod ( )

Retrieves the HTTP method of the request.

Returns: string Returns the request method.

Implements MediaWiki\Rest\RequestInterface.

Definition at line 30 of file RequestFromGlobals.php.

◆ getPostParams()

MediaWiki\Rest\RequestFromGlobals::getPostParams ( )

Retrieve POST form parameters.

This will return an array of parameters in the format of $_POST.

Returns: array The deserialized POST parameters

Implements MediaWiki\Rest\RequestInterface.

Definition at line 101 of file RequestFromGlobals.php.

◆ getProtocolVersion()

MediaWiki\Rest\RequestFromGlobals::getProtocolVersion ( )

Retrieves the HTTP protocol version as a string.

The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").

Returns: string HTTP protocol version.

Implements MediaWiki\Rest\RequestInterface.

Definition at line 59 of file RequestFromGlobals.php.

◆ getQueryParams()

MediaWiki\Rest\RequestFromGlobals::getQueryParams ( )

Retrieve query string arguments.

Retrieves the deserialized query string arguments, if any.

Note: the query params might not be in sync with the URI or server params. If you need to ensure you are only getting the original values, you may need to parse the query string from getUri()->getQuery() or from the QUERY_STRING server param.

Returns: array

Implements MediaWiki\Rest\RequestInterface.

Definition at line 90 of file RequestFromGlobals.php.

◆ getServerParams()

MediaWiki\Rest\RequestFromGlobals::getServerParams ( )

Retrieve server parameters.

Retrieves data related to the incoming request environment, typically derived from PHP's $_SERVER superglobal. The data IS NOT REQUIRED to originate from $_SERVER.