MediaWiki  1.34.0
RequestData.php
Go to the documentation of this file.
1 <?php
2 
3 namespace MediaWiki\Rest;
4 
5 use GuzzleHttp\Psr7\Uri;
6 use Psr\Http\Message\StreamInterface;
7 use Psr\Http\Message\UploadedFileInterface;
8 use Psr\Http\Message\UriInterface;
9 
14 class RequestData extends RequestBase {
15  private $method;
16 
18  private $uri;
19 
21 
23  private $body;
24 
25  private $serverParams;
26 
27  private $cookieParams;
28 
29  private $queryParams;
30 
32  private $uploadedFiles;
33 
34  private $postParams;
35 
54  public function __construct( $params = [] ) {
55  $this->method = $params['method'] ?? 'GET';
56  $this->uri = $params['uri'] ?? new Uri;
57  $this->protocolVersion = $params['protocolVersion'] ?? '1.1';
58  $this->body = new StringStream( $params['bodyContents'] ?? '' );
59  $this->serverParams = $params['serverParams'] ?? [];
60  $this->cookieParams = $params['cookieParams'] ?? [];
61  $this->queryParams = $params['queryParams'] ?? [];
62  $this->uploadedFiles = $params['uploadedFiles'] ?? [];
63  $this->postParams = $params['postParams'] ?? [];
64  $this->setPathParams( $params['pathParams'] ?? [] );
65  $this->setHeaders( $params['headers'] ?? [] );
66  parent::__construct( $params['cookiePrefix'] ?? '' );
67  }
68 
69  public function getMethod() {
70  return $this->method;
71  }
72 
73  public function getUri() {
74  return $this->uri;
75  }
76 
77  public function getProtocolVersion() {
79  }
80 
81  public function getBody() {
82  return $this->body;
83  }
84 
85  public function getServerParams() {
86  return $this->serverParams;
87  }
88 
89  public function getCookieParams() {
90  return $this->cookieParams;
91  }
92 
93  public function getQueryParams() {
94  return $this->queryParams;
95  }
96 
97  public function getUploadedFiles() {
98  return $this->uploadedFiles;
99  }
100 
101  public function getPostParams() {
102  return $this->postParams;
103  }
104 }
MediaWiki\Rest\RequestData\getQueryParams
getQueryParams()
Retrieve query string arguments.
Definition: RequestData.php:93
MediaWiki\Rest\RequestData\getMethod
getMethod()
Retrieves the HTTP method of the request.
Definition: RequestData.php:69
MediaWiki\Rest\RequestData\$postParams
$postParams
Definition: RequestData.php:34
MediaWiki\Rest\RequestData\getPostParams
getPostParams()
Retrieve POST form parameters.
Definition: RequestData.php:101
MediaWiki\Rest\StringStream
A stream class which uses a string as the underlying storage.
Definition: StringStream.php:16
MediaWiki\Rest\RequestData\$method
$method
Definition: RequestData.php:15
MediaWiki\Rest\RequestData\$serverParams
$serverParams
Definition: RequestData.php:25
MediaWiki\Rest\RequestBase\setPathParams
setPathParams( $params)
Erase all path parameters from the object and set the parameter array to the one specified.
Definition: RequestBase.php:86
MediaWiki\Rest\RequestData\__construct
__construct( $params=[])
Construct a RequestData from an array of parameters.
Definition: RequestData.php:54
MediaWiki\Rest\RequestData\getProtocolVersion
getProtocolVersion()
Retrieves the HTTP protocol version as a string.
Definition: RequestData.php:77
MediaWiki\Rest\RequestData\getCookieParams
getCookieParams()
Retrieve cookies.
Definition: RequestData.php:89
MediaWiki\Rest\RequestData\$cookieParams
$cookieParams
Definition: RequestData.php:27
MediaWiki\Rest\RequestData\getUploadedFiles
getUploadedFiles()
Retrieve normalized file upload data.
Definition: RequestData.php:97
MediaWiki\Rest
MediaWiki\Rest\RequestData\getUri
getUri()
Retrieves the URI instance.
Definition: RequestData.php:73
MediaWiki\Rest\RequestBase\setHeaders
setHeaders( $headers)
Erase any existing headers and replace them with the specified header lines.
Definition: RequestBase.php:53
MediaWiki\Rest\RequestData\getServerParams
getServerParams()
Retrieve server parameters.
Definition: RequestData.php:85
MediaWiki\Rest\RequestData\$uploadedFiles
UploadedFileInterface[] $uploadedFiles
Definition: RequestData.php:32
MediaWiki\Rest\RequestData\$queryParams
$queryParams
Definition: RequestData.php:29
MediaWiki\Rest\RequestData\$protocolVersion
$protocolVersion
Definition: RequestData.php:20
MediaWiki\Rest\RequestData\getBody
getBody()
Gets the body of the message.
Definition: RequestData.php:81
MediaWiki\Rest\RequestData
This is a Request class that allows data to be injected, for the purposes of testing or internal requ...
Definition: RequestData.php:14
MediaWiki\Rest\RequestBase
Shared code between RequestData and RequestFromGlobals.
Definition: RequestBase.php:8
MediaWiki\Rest\RequestData\$uri
UriInterface $uri
Definition: RequestData.php:18
MediaWiki\Rest\RequestData\$body
StreamInterface $body
Definition: RequestData.php:23