ServerRequest::getServerParams() - Code Metrics - dmt-software/aura-web-psr - Measure and Improve Code Quality continuously with Scrutinizer

ServerRequest::getServerParams() A
last analyzed 2021-12-31 16:34 UTC

↳ Parent: ServerRequest

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	1
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10

<?php

namespace DMT\Aura\Psr\Message;

use ArrayObject;
use Aura\Web\Request as AuraRequest;
use InvalidArgumentException;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\UploadedFileInterface;
use Psr\Http\Message\UriInterface;
use stdClass;

/**
 * Class ServerRequest
 *
 * @package DMT\Aura\Psr\Message
 */
class ServerRequest extends Request implements ServerRequestInterface
{
    /** @var UploadedFile[] $uploadedFiles */
    private $uploadedFiles;

    /**
     * ServerRequest constructor.
     *
     * @param string $method
     * @param string|UriInterface $uri
     * @param array $serverParams
     */
    public function __construct(string $method, $uri, array $serverParams = [])
    {
        parent::__construct($method, $uri);

        $request = $this->getInnerObject();
        $request->server->exchangeArray(['REQUEST_METHOD' => $method] + $serverParams);

        $this->setObjectProperty(
            $request ,
            'headers',
            new AuraRequest\Headers($request->server->get())
        );
    }

    /**
     * Retrieve server parameters.
     *
     * @return array
     */
    public function getServerParams(): array
    {
        return $this->getInnerObject()->server->get();
    }

    /**
     * Retrieve cookies.
     *
     * @return array
     */
    public function getCookieParams(): array
    {
        return $this->getInnerObject()->cookies->get();
    }

    /**
     * Return an instance with the specified cookies.
     *
     * @param array $cookies
     * @return static
     */
    public function withCookieParams(array $cookies): self
    {
        $instance = clone($this);

        $this->setObjectProperty(
            $instance->getInnerObject(),
            'cookies',
            new AuraRequest\Values($cookies)
        );

        return $instance;
    }

    /**
     * Retrieve query string arguments.
     *
     * @return array
     */
    public function getQueryParams(): array
    {
        return $this->getInnerObject()->query->get();
    }

    /**
     * Return an instance with the specified query string arguments.
     *
     * @param array $query
     * @return static
     */
    public function withQueryParams(array $query): self
    {
        $instance = clone($this);

        $this->setObjectProperty(
            $instance->getInnerObject(),
            'query',
            new AuraRequest\Values($query)
        );

        return $instance;
    }

    /**
     * Retrieve normalized file upload data.
     *
     * @return array
     */
    public function getUploadedFiles(): array
    {
        return $this->uploadedFiles ?? [];
    }

    /**
     * Create a new instance with the specified uploaded files.
     *
     * @param array|UploadedFileInterface[] $uploadedFiles
     * @return static
     * @throws InvalidArgumentException
     */
    public function withUploadedFiles(array $uploadedFiles): self
    {
        $files = [];
        $uploadedFiles = $this->checkUploadedFiles($uploadedFiles, $files);

        $instance = clone($this);
        $instance->uploadedFiles = $uploadedFiles;
        $instance->getInnerObject()->files->exchangeArray($files);

        return $instance;
    }

    public function checkUploadedFiles($uploadedFiles, &$entry)
    {
        foreach ($uploadedFiles as $file => &$uploadedFile) {
            if (is_array($uploadedFile)) {
                $uploadedFile = $this->checkUploadedFiles($uploadedFile, $entry[$file]);
                continue;
            }

            if (!$uploadedFile instanceof UploadedFileInterface) {
                throw new InvalidArgumentException('illegal uploaded file entry');
            }

            if (!$uploadedFile instanceof UploadedFile) {
                $uploadedFile = new UploadedFile(
                    new Stream($uploadedFile->getStream()->detach()),
                    $uploadedFile->getSize(),
                    $uploadedFile->getError(),
                    $uploadedFile->getClientFilename(),
                    $uploadedFile->getClientMediaType()
                );
            }

            $entry[$file] = $uploadedFile->getInnerObject()->getArrayCopy();
        }

        return $uploadedFiles;
    }

    /**
     * Retrieve any parameters provided in the request body.
     *
     * NOTE: objects are casted to arrays before storage
     *
     * @return null|array|object
     */
    public function getParsedBody()
    {
        $data = $this->getInnerObject()->post->get();

        if ((ArrayObject::ARRAY_AS_PROPS & $this->getInnerObject()->post->getFlags()) > 0) {
            return (object)$data;
        }

        return $data ?: null;
    }

    /**
     * Return an instance with the specified body parameters.
     *
     * @param null|array|object $data
     * @return static
     * @throws InvalidArgumentException
     */
    public function withParsedBody($data): self
    {
        if (!is_null($data) && !is_array($data) && !$data instanceof stdClass) {
            throw new InvalidArgumentException('unsupported body type used');
        }

        $instance = clone($this);
        $instance->getInnerObject()->post->exchangeArray((array)$data);

        if (is_object($data)) {
            $instance->getInnerObject()->post->setFlags(ArrayObject::ARRAY_AS_PROPS);
        }

        return $instance;
    }

    /**
     * Retrieve attributes derived from the request.
     *
     * @return array Attributes derived from the request.
     */
    public function getAttributes(): array
    {
        return $this->getInnerObject()->params->get() ?? [];
    }

    /**
     * Retrieve a single derived request attribute.
     *
     * @param string $name The attribute name.
     * @param mixed $default Default value to return if the attribute does not exist.
     * @return mixed
     */
    public function getAttribute($name, $default = null)
    {
        return $this->getInnerObject()->params->get($name, $default);
    }

    /**
     * Return an instance with the specified derived request attribute.
     *
     * This method allows setting a single derived request attribute as
     * described in getAttributes().
     *
     * This method MUST be implemented in such a way as to retain the
     * immutability of the message, and MUST return an instance that has the
     * updated attribute.
     *
     * @see getAttributes()
     * @param string $name The attribute name.
     * @param mixed $value The value of the attribute.
     * @return static
     */
    public function withAttribute($name, $value)
    {
        $params = $this->getAttributes();
        $params[$name] = $value;

        $instance = clone($this);
        $instance->getInnerObject()->params->set($params);

        return $instance;
    }

    /**
     * Return an instance that removes the specified derived request attribute.
     *
     * @param string $name The attribute name.
     * @return static
     */
    public function withoutAttribute($name)
    {
        $params = $this->getAttributes();
        unset($params[$name]);

        $instance = clone($this);
        $instance->getInnerObject()->params->set($params);

        return $instance;
    }
}


1		<?php
2
3		namespace DMT\Aura\Psr\Message;
4
5		use ArrayObject;
6		use Aura\Web\Request as AuraRequest;
7		use InvalidArgumentException;
8		use Psr\Http\Message\ServerRequestInterface;
9		use Psr\Http\Message\UploadedFileInterface;
10		use Psr\Http\Message\UriInterface;
11		use stdClass;
12
13		/**
14		* Class ServerRequest
15		*
16		* @package DMT\Aura\Psr\Message
17		*/
18		class ServerRequest extends Request implements ServerRequestInterface
19		{
20		/** @var UploadedFile[] $uploadedFiles */
21		private $uploadedFiles;
22
23		/**
24		* ServerRequest constructor.
25		*
26		* @param string $method
27		* @param string\|UriInterface $uri
28		* @param array $serverParams
29		*/
30	16	public function __construct(string $method, $uri, array $serverParams = [])
31		{
32	16	parent::__construct($method, $uri);
33
34	16	$request = $this->getInnerObject();
35	16	$request->server->exchangeArray(['REQUEST_METHOD' => $method] + $serverParams);
36
37	16	$this->setObjectProperty(
38	16	$request ,
39	16	'headers',
40	16	new AuraRequest\Headers($request->server->get())
41		);
42	16	}
43
44		/**
45		* Retrieve server parameters.
46		*
47		* @return array
48		*/
49	2	public function getServerParams(): array
50		{
51	2	return $this->getInnerObject()->server->get();
52		}
53
54		/**
55		* Retrieve cookies.
56		*
57		* @return array
58		*/
59	2	public function getCookieParams(): array
60		{
61	2	return $this->getInnerObject()->cookies->get();
62		}
63
64		/**
65		* Return an instance with the specified cookies.
66		*
67		* @param array $cookies
68		* @return static
69		*/
70	1	public function withCookieParams(array $cookies): self
71		{
72	1	$instance = clone($this);
73
74	1	$this->setObjectProperty(
75	1	$instance->getInnerObject(),
76	1	'cookies',
77	1	new AuraRequest\Values($cookies)
78		);
79
80	1	return $instance;
81		}
82
83		/**
84		* Retrieve query string arguments.
85		*
86		* @return array
87		*/
88	1	public function getQueryParams(): array
89		{
90	1	return $this->getInnerObject()->query->get();
91		}
92
93		/**
94		* Return an instance with the specified query string arguments.
95		*
96		* @param array $query
97		* @return static
98		*/
99	1	public function withQueryParams(array $query): self
100		{
101	1	$instance = clone($this);
102
103	1	$this->setObjectProperty(
104	1	$instance->getInnerObject(),
105	1	'query',
106	1	new AuraRequest\Values($query)
107		);
108
109	1	return $instance;
110		}
111
112		/**
113		* Retrieve normalized file upload data.
114		*
115		* @return array
116		*/
117	1	public function getUploadedFiles(): array
118		{
119	1	return $this->uploadedFiles ?? [];
120		}
121
122		/**
123		* Create a new instance with the specified uploaded files.
124		*
125		* @param array\|UploadedFileInterface[] $uploadedFiles
126		* @return static
127		* @throws InvalidArgumentException
128		*/
129	1	public function withUploadedFiles(array $uploadedFiles): self
130		{
131	1	$files = [];
132	1	$uploadedFiles = $this->checkUploadedFiles($uploadedFiles, $files);
133
134	1	$instance = clone($this);
135	1	$instance->uploadedFiles = $uploadedFiles;
136	1	$instance->getInnerObject()->files->exchangeArray($files);
137
138	1	return $instance;
139		}
140
141	1	public function checkUploadedFiles($uploadedFiles, &$entry)
142		{
143	1	foreach ($uploadedFiles as $file => &$uploadedFile) {
144	1	if (is_array($uploadedFile)) {
145		$uploadedFile = $this->checkUploadedFiles($uploadedFile, $entry[$file]);
146		continue;
147		}
148
149	1	if (!$uploadedFile instanceof UploadedFileInterface) {
150		throw new InvalidArgumentException('illegal uploaded file entry');
151		}
152
153	1	if (!$uploadedFile instanceof UploadedFile) {
154		$uploadedFile = new UploadedFile(
155		new Stream($uploadedFile->getStream()->detach()),
156		$uploadedFile->getSize(),
157		$uploadedFile->getError(),
158		$uploadedFile->getClientFilename(),
159		$uploadedFile->getClientMediaType()
160		);
161		}
162
163	1	$entry[$file] = $uploadedFile->getInnerObject()->getArrayCopy();
164		}
165
166	1	return $uploadedFiles;
167		}
168
169		/**
170		* Retrieve any parameters provided in the request body.
171		*
172		* NOTE: objects are casted to arrays before storage
173		*
174		* @return null\|array\|object
175		*/
176	3	public function getParsedBody()
177		{
178	3	$data = $this->getInnerObject()->post->get();
179
180	3	if ((ArrayObject::ARRAY_AS_PROPS & $this->getInnerObject()->post->getFlags()) > 0) {
181	1	return (object)$data;
182		}
183
184	3	return $data ?: null;
185		}
186
187		/**
188		* Return an instance with the specified body parameters.
189		*
190		* @param null\|array\|object $data
191		* @return static
192		* @throws InvalidArgumentException
193		*/
194	7	public function withParsedBody($data): self
195		{
196	7	if (!is_null($data) && !is_array($data) && !$data instanceof stdClass) {
197	4	throw new InvalidArgumentException('unsupported body type used');
198		}
199
200	3	$instance = clone($this);
201	3	$instance->getInnerObject()->post->exchangeArray((array)$data);
202
203	3	if (is_object($data)) {
204	1	$instance->getInnerObject()->post->setFlags(ArrayObject::ARRAY_AS_PROPS);
205		}
206
207	3	return $instance;
208		}
209
210		/**
211		* Retrieve attributes derived from the request.
212		*
213		* @return array Attributes derived from the request.
214		*/
215	3	public function getAttributes(): array
216		{
217	3	return $this->getInnerObject()->params->get() ?? [];
218		}
219
220		/**
221		* Retrieve a single derived request attribute.
222		*
223		* @param string $name The attribute name.
224		* @param mixed $default Default value to return if the attribute does not exist.
225		* @return mixed
226		*/
227	2	public function getAttribute($name, $default = null)
228		{
229	2	return $this->getInnerObject()->params->get($name, $default);
230		}
231
232		/**
233		* Return an instance with the specified derived request attribute.
234		*
235		* This method allows setting a single derived request attribute as
236		* described in getAttributes().
237		*
238		* This method MUST be implemented in such a way as to retain the
239		* immutability of the message, and MUST return an instance that has the
240		* updated attribute.
241		*
242		* @see getAttributes()
243		* @param string $name The attribute name.
244		* @param mixed $value The value of the attribute.
245		* @return static
246		*/
247	3	public function withAttribute($name, $value)
248		{
249	3	$params = $this->getAttributes();
250	3	$params[$name] = $value;
251
252	3	$instance = clone($this);
253	3	$instance->getInnerObject()->params->set($params);
254
255	3	return $instance;
256		}
257
258		/**
259		* Return an instance that removes the specified derived request attribute.
260		*
261		* @param string $name The attribute name.
262		* @return static
263		*/
264	1	public function withoutAttribute($name)
265		{
266	1	$params = $this->getAttributes();
267	1	unset($params[$name]);
268
269	1	$instance = clone($this);
270	1	$instance->getInnerObject()->params->set($params);
271
272	1	return $instance;
273		}
274		}
275

dmt-software / aura-web-psr

ServerRequest::getServerParams() A last analyzed 2021-12-31 16:34 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ServerRequest::getServerParams() A
last analyzed 2021-12-31 16:34 UTC