MediaWiki  master
RequestInterface.php
Go to the documentation of this file.
1 <?php
2 
31 namespace MediaWiki\Rest;
32 
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 }
setPathParams( $params)
Erase all path parameters from the object and set the parameter array to the one specified.
getCookie( $name, $default=null)
Add the cookie prefix to a specified cookie name and get the value of the resulting prefixed cookie...
getPostParams()
Retrieve POST form parameters.
getQueryParams()
Retrieve query string arguments.
getPathParams()
Get the parameters derived from the path template match.
getHeaders()
Retrieves all message header values.
getHeader( $name)
Retrieves a message header value by the given case-insensitive name.
getMethod()
Retrieves the HTTP method of the request.
getBody()
Gets the body of the message.
getCookiePrefix()
Get the current cookie prefix.
getPathParam( $name)
Retrieve a single path parameter.
hasHeader( $name)
Checks if a header exists by the given case-insensitive name.
A request interface similar to PSR-7&#39;s ServerRequestInterface.
getProtocolVersion()
Retrieves the HTTP protocol version as a string.
getUri()
Retrieves the URI instance.
getCookieParams()
Retrieve cookies.
getUploadedFiles()
Retrieve normalized file upload data.
getServerParams()
Retrieve server parameters.
getHeaderLine( $name)
Retrieves a comma-separated string of the values for a single header.