MediaWiki  master
RequestInterface.php
Go to the documentation of this file.
1 <?php
2 
31 namespace MediaWiki\Rest;
32 
33 use Psr\Http\Message\StreamInterface;
34 use Psr\Http\Message\UriInterface;
35 
39 interface RequestInterface {
40  // RequestInterface
41 
47  function getMethod();
48 
58  function getUri();
59 
60  // MessageInterface
61 
69  function getProtocolVersion();
70 
100  function getHeaders();
101 
120  function getHeader( $name );
121 
130  function hasHeader( $name );
131 
151  function getHeaderLine( $name );
152 
158  function getBody();
159 
160  // ServerRequestInterface
161 
171  function getServerParams();
172 
183  function getCookieParams();
184 
197  function getQueryParams();
198 
208  function getUploadedFiles();
209 
210  // MediaWiki extensions to PSR-7
211 
217  function getPathParams();
218 
229  function getPathParam( $name );
230 
237  function setPathParams( $params );
238 
244  function getCookiePrefix();
245 
255  function getCookie( $name, $default = null );
256 
264  function getPostParams();
265 }
MediaWiki\Rest\RequestInterface\getPostParams
getPostParams()
Retrieve POST form parameters.
MediaWiki\Rest\RequestInterface\getQueryParams
getQueryParams()
Retrieve query string arguments.
MediaWiki\Rest\RequestInterface\setPathParams
setPathParams( $params)
Erase all path parameters from the object and set the parameter array to the one specified.
MediaWiki\Rest\RequestInterface\getHeader
getHeader( $name)
Retrieves a message header value by the given case-insensitive name.
MediaWiki\Rest\RequestInterface\getHeaders
getHeaders()
Retrieves all message header values.
MediaWiki\Rest\RequestInterface\getCookie
getCookie( $name, $default=null)
Add the cookie prefix to a specified cookie name and get the value of the resulting prefixed cookie.
MediaWiki\Rest\RequestInterface\getPathParams
getPathParams()
Get the parameters derived from the path template match.
MediaWiki\Rest\RequestInterface\getCookiePrefix
getCookiePrefix()
Get the current cookie prefix.
MediaWiki\Rest\RequestInterface\getBody
getBody()
Gets the body of the message.
MediaWiki\Rest\RequestInterface\getPathParam
getPathParam( $name)
Retrieve a single path parameter.
MediaWiki\Rest\RequestInterface\hasHeader
hasHeader( $name)
Checks if a header exists by the given case-insensitive name.
MediaWiki\Rest\RequestInterface\getMethod
getMethod()
Retrieves the HTTP method of the request.
MediaWiki\Rest\RequestInterface\getProtocolVersion
getProtocolVersion()
Retrieves the HTTP protocol version as a string.
MediaWiki\Rest
MediaWiki\Rest\RequestInterface\getUri
getUri()
Retrieves the URI instance.
MediaWiki\Rest\RequestInterface
A request interface similar to PSR-7's ServerRequestInterface.
Definition: RequestInterface.php:39
MediaWiki\Rest\RequestInterface\getCookieParams
getCookieParams()
Retrieve cookies.
MediaWiki\Rest\RequestInterface\getHeaderLine
getHeaderLine( $name)
Retrieves a comma-separated string of the values for a single header.
MediaWiki\Rest\RequestInterface\getServerParams
getServerParams()
Retrieve server parameters.
MediaWiki\Rest\RequestInterface\getUploadedFiles
getUploadedFiles()
Retrieve normalized file upload data.