Chris@0: <?php
Chris@0: /**
Chris@12:  * @see       https://github.com/zendframework/zend-diactoros for the canonical source repository
Chris@12:  * @copyright Copyright (c) 2015-2017 Zend Technologies USA Inc. (http://www.zend.com)
Chris@0:  * @license   https://github.com/zendframework/zend-diactoros/blob/master/LICENSE.md New BSD License
Chris@0:  */
Chris@0: 
Chris@0: namespace Zend\Diactoros;
Chris@0: 
Chris@0: use InvalidArgumentException;
Chris@0: use Psr\Http\Message\ServerRequestInterface;
Chris@0: use Psr\Http\Message\StreamInterface;
Chris@0: use Psr\Http\Message\UploadedFileInterface;
Chris@0: use Psr\Http\Message\UriInterface;
Chris@0: 
Chris@16: use function array_key_exists;
Chris@16: use function is_array;
Chris@16: 
Chris@0: /**
Chris@0:  * Server-side HTTP request
Chris@0:  *
Chris@0:  * Extends the Request definition to add methods for accessing incoming data,
Chris@0:  * specifically server parameters, cookies, matched path parameters, query
Chris@0:  * string arguments, body parameters, and upload file information.
Chris@0:  *
Chris@0:  * "Attributes" are discovered via decomposing the request (and usually
Chris@0:  * specifically the URI path), and typically will be injected by the application.
Chris@0:  *
Chris@0:  * Requests are considered immutable; all methods that might change state are
Chris@0:  * implemented such that they retain the internal state of the current
Chris@0:  * message and return a new instance that contains the changed state.
Chris@0:  */
Chris@0: class ServerRequest implements ServerRequestInterface
Chris@0: {
Chris@0:     use RequestTrait;
Chris@0: 
Chris@0:     /**
Chris@0:      * @var array
Chris@0:      */
Chris@0:     private $attributes = [];
Chris@0: 
Chris@0:     /**
Chris@0:      * @var array
Chris@0:      */
Chris@0:     private $cookieParams = [];
Chris@0: 
Chris@0:     /**
Chris@0:      * @var null|array|object
Chris@0:      */
Chris@0:     private $parsedBody;
Chris@0: 
Chris@0:     /**
Chris@0:      * @var array
Chris@0:      */
Chris@0:     private $queryParams = [];
Chris@0: 
Chris@0:     /**
Chris@0:      * @var array
Chris@0:      */
Chris@0:     private $serverParams;
Chris@0: 
Chris@0:     /**
Chris@0:      * @var array
Chris@0:      */
Chris@0:     private $uploadedFiles;
Chris@0: 
Chris@0:     /**
Chris@0:      * @param array $serverParams Server parameters, typically from $_SERVER
Chris@0:      * @param array $uploadedFiles Upload file information, a tree of UploadedFiles
Chris@0:      * @param null|string|UriInterface $uri URI for the request, if any.
Chris@0:      * @param null|string $method HTTP method for the request, if any.
Chris@0:      * @param string|resource|StreamInterface $body Message body, if any.
Chris@0:      * @param array $headers Headers for the message, if any.
Chris@0:      * @param array $cookies Cookies for the message, if any.
Chris@0:      * @param array $queryParams Query params for the message, if any.
Chris@0:      * @param null|array|object $parsedBody The deserialized body parameters, if any.
Chris@0:      * @param string $protocol HTTP protocol version.
Chris@0:      * @throws InvalidArgumentException for any invalid value.
Chris@0:      */
Chris@0:     public function __construct(
Chris@0:         array $serverParams = [],
Chris@0:         array $uploadedFiles = [],
Chris@0:         $uri = null,
Chris@0:         $method = null,
Chris@0:         $body = 'php://input',
Chris@0:         array $headers = [],
Chris@0:         array $cookies = [],
Chris@0:         array $queryParams = [],
Chris@0:         $parsedBody = null,
Chris@0:         $protocol = '1.1'
Chris@0:     ) {
Chris@0:         $this->validateUploadedFiles($uploadedFiles);
Chris@0: 
Chris@0:         if ($body === 'php://input') {
Chris@0:             $body = new PhpInputStream();
Chris@0:         }
Chris@0: 
Chris@0:         $this->initialize($uri, $method, $body, $headers);
Chris@0:         $this->serverParams  = $serverParams;
Chris@0:         $this->uploadedFiles = $uploadedFiles;
Chris@0:         $this->cookieParams  = $cookies;
Chris@0:         $this->queryParams   = $queryParams;
Chris@0:         $this->parsedBody    = $parsedBody;
Chris@0:         $this->protocol      = $protocol;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function getServerParams()
Chris@0:     {
Chris@0:         return $this->serverParams;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function getUploadedFiles()
Chris@0:     {
Chris@0:         return $this->uploadedFiles;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function withUploadedFiles(array $uploadedFiles)
Chris@0:     {
Chris@0:         $this->validateUploadedFiles($uploadedFiles);
Chris@0:         $new = clone $this;
Chris@0:         $new->uploadedFiles = $uploadedFiles;
Chris@0:         return $new;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function getCookieParams()
Chris@0:     {
Chris@0:         return $this->cookieParams;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function withCookieParams(array $cookies)
Chris@0:     {
Chris@0:         $new = clone $this;
Chris@0:         $new->cookieParams = $cookies;
Chris@0:         return $new;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function getQueryParams()
Chris@0:     {
Chris@0:         return $this->queryParams;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function withQueryParams(array $query)
Chris@0:     {
Chris@0:         $new = clone $this;
Chris@0:         $new->queryParams = $query;
Chris@0:         return $new;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function getParsedBody()
Chris@0:     {
Chris@0:         return $this->parsedBody;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function withParsedBody($data)
Chris@0:     {
Chris@17:         if (! is_array($data) && ! is_object($data) && null !== $data) {
Chris@17:             throw new InvalidArgumentException(sprintf(
Chris@17:                 '%s expects a null, array, or object argument; received %s',
Chris@17:                 __METHOD__,
Chris@17:                 gettype($data)
Chris@17:             ));
Chris@17:         }
Chris@17: 
Chris@0:         $new = clone $this;
Chris@0:         $new->parsedBody = $data;
Chris@0:         return $new;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function getAttributes()
Chris@0:     {
Chris@0:         return $this->attributes;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function getAttribute($attribute, $default = null)
Chris@0:     {
Chris@0:         if (! array_key_exists($attribute, $this->attributes)) {
Chris@0:             return $default;
Chris@0:         }
Chris@0: 
Chris@0:         return $this->attributes[$attribute];
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function withAttribute($attribute, $value)
Chris@0:     {
Chris@0:         $new = clone $this;
Chris@0:         $new->attributes[$attribute] = $value;
Chris@0:         return $new;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function withoutAttribute($attribute)
Chris@0:     {
Chris@0:         $new = clone $this;
Chris@0:         unset($new->attributes[$attribute]);
Chris@0:         return $new;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Proxy to receive the request method.
Chris@0:      *
Chris@0:      * This overrides the parent functionality to ensure the method is never
Chris@0:      * empty; if no method is present, it returns 'GET'.
Chris@0:      *
Chris@0:      * @return string
Chris@0:      */
Chris@0:     public function getMethod()
Chris@0:     {
Chris@0:         if (empty($this->method)) {
Chris@0:             return 'GET';
Chris@0:         }
Chris@0:         return $this->method;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Set the request method.
Chris@0:      *
Chris@0:      * Unlike the regular Request implementation, the server-side
Chris@0:      * normalizes the method to uppercase to ensure consistency
Chris@0:      * and make checking the method simpler.
Chris@0:      *
Chris@0:      * This methods returns a new instance.
Chris@0:      *
Chris@0:      * @param string $method
Chris@0:      * @return self
Chris@0:      */
Chris@0:     public function withMethod($method)
Chris@0:     {
Chris@0:         $this->validateMethod($method);
Chris@0:         $new = clone $this;
Chris@0:         $new->method = $method;
Chris@0:         return $new;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Recursively validate the structure in an uploaded files array.
Chris@0:      *
Chris@0:      * @param array $uploadedFiles
Chris@0:      * @throws InvalidArgumentException if any leaf is not an UploadedFileInterface instance.
Chris@0:      */
Chris@0:     private function validateUploadedFiles(array $uploadedFiles)
Chris@0:     {
Chris@0:         foreach ($uploadedFiles as $file) {
Chris@0:             if (is_array($file)) {
Chris@0:                 $this->validateUploadedFiles($file);
Chris@0:                 continue;
Chris@0:             }
Chris@0: 
Chris@0:             if (! $file instanceof UploadedFileInterface) {
Chris@0:                 throw new InvalidArgumentException('Invalid leaf in uploaded files structure');
Chris@0:             }
Chris@0:         }
Chris@0:     }
Chris@0: }