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