src/YurunHttp/Http/Psr7ServerRequest.php

<?php
namespace Yurun\Util\YurunHttp\Http\Psr7;

use Yurun\Util\YurunHttp\Http\Psr7\UploadedFile;
use Psr\Http\Message\ServerRequestInterface;
use Yurun\Util\YurunHttp;
use Yurun\Util\YurunHttp\Http\Psr7\Consts\MediaType;
use Yurun\Util\YurunHttp\Http\Psr7\Consts\RequestHeader;
use Yurun\Util\YurunHttp\Http\Psr7\Consts\RequestMethod;

class ServerRequest extends Request implements ServerRequestInterface
{
    /**
     * 服务器信息
     * @var array
     */
    protected $server = [];

    /**
     * cookie数据
     * @var array
     */
    protected $cookies = [];
    
    /**
     * get数据
     * @var array
     */
    protected $get = [];

    /**
     * post数据
     * @var array
     */
    protected $post = [];

    /**
     * 上传的文件
     * @var \Yurun\Util\YurunHttp\Http\Psr7\UploadedFile[]
     */
    protected $files = [];

    /**
     * 处理过的主体内容
     * @var null|array|object
     */
    protected $parsedBody;
    
    /**
     * 属性数组
     *
     * @var array
     */
    protected $attributes = [];

    public function __construct($uri = null, array $headers = [], $body = '', $method = RequestMethod::GET, $version = '1.1', array $server = [], array $cookies = [], array $files = [])
    {
        $this->server = $server;
        $this->cookies = $cookies;
        parent::__construct($uri, $headers, $body, $method, $version);
        $this->parseParsedBody();
        $this->setUploadedFiles($this, $files);
    }

    /**
     * Retrieve server parameters.
     *
     * Retrieves data related to the incoming request environment,
     * typically derived from PHP's $_SERVER superglobal. The data IS NOT
     * REQUIRED to originate from $_SERVER.
     *
     * @return array
     */
    public function getServerParams()
    {
        return $this->server;
    }
    
    /**
     * 获取server参数
     * @param string $name
     * @param mixed $default
     * @return string
     */
    public function getServerParam($name, $default = null)
    {
        return isset($this->server[$name]) ? $this->server[$name] : $default;
    }

    /**
     * Retrieve cookies.
     *
     * Retrieves cookies sent by the client to the server.
     *
     * The data MUST be compatible with the structure of the $_COOKIE
     * superglobal.
     *
     * @return array
     */
    public function getCookieParams()
    {
        return $this->cookies;
    }

    /**
     * Return an instance with the specified cookies.
     *
     * The data IS NOT REQUIRED to come from the $_COOKIE superglobal, but MUST
     * be compatible with the structure of $_COOKIE. Typically, this data will
     * be injected at instantiation.
     *
     * This method MUST NOT update the related Cookie header of the request
     * instance, nor related values in the server params.
     *
     * 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 cookie values.
     *
     * @param array $cookies Array of key/value pairs representing cookies.
     * @return static
     */
    public function withCookieParams(array $cookies)
    {
        $self = clone $this;
        $self->cookies = $cookies;
        return $self;
    }
    
    /**
     * 获取cookie值
     * @param string $name
     * @param mixed $default
     * @return mixed
     */
    public function getCookie($name, $default = null)
    {
        return isset($this->cookies[$name]) ? $this->cookies[$name] : $default;
    }

    /**
     * Retrieve query string arguments.
     *
     * Retrieves the deserialized query string arguments, if any.
     *
     * Note: the query params might not be in sync with the URI or server
     * params. If you need to ensure you are only getting the original
     * values, you may need to parse the query string from `getUri()->getQuery()`
     * or from the `QUERY_STRING` server param.
     *
     * @return array
     */
    public function getQueryParams()
    {
        return $this->get;
    }

    /**
     * Return an instance with the specified query string arguments.
     *
     * These values SHOULD remain immutable over the course of the incoming
     * request. They MAY be injected during instantiation, such as from PHP's
     * $_GET superglobal, or MAY be derived from some other value such as the
     * URI. In cases where the arguments are parsed from the URI, the data
     * MUST be compatible with what PHP's parse_str() would return for
     * purposes of how duplicate query parameters are handled, and how nested
     * sets are handled.
     *
     * Setting query string arguments MUST NOT change the URI stored by the
     * request, nor the values in the server params.
     *
     * 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 query string arguments.
     *
     * @param array $query Array of query string arguments, typically from
     *     $_GET.
     * @return static
     */
    public function withQueryParams(array $query)
    {
        $self = clone $this;
        $self->get = $query;
        return $self;
    }

    /**
     * Retrieve normalized file upload data.
     *
     * This method returns upload metadata in a normalized tree, with each leaf
     * an instance of Psr\Http\Message\UploadedFileInterface.
     *
     * These values MAY be prepared from $_FILES or the message body during
     * instantiation, or MAY be injected via withUploadedFiles().
     *
     * @return UploadedFile[] An array tree of UploadedFileInterface instances; an empty
     *     array MUST be returned if no data is present.
     */
    public function getUploadedFiles()
    {
        return $this->files;
    }

    /**
     * Create a new instance with the specified uploaded files.
     *
     * 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 body parameters.
     *
     * @param array An array tree of UploadedFileInterface instances.
     * @return static
     * @throws \InvalidArgumentException if an invalid structure is provided.
     */
    public function withUploadedFiles(array $uploadedFiles)
    {
        $self = clone $this;
        return $this->setUploadedFiles($self, $uploadedFiles);
    }

    /**
     * Retrieve any parameters provided in the request body.
     *
     * If the request Content-Type is either application/x-www-form-urlencoded
     * or multipart/form-data, and the request method is POST, this method MUST
     * return the contents of $_POST.
     *
     * Otherwise, this method may return any results of deserializing
     * the request body content; as parsing returns structured content, the
     * potential types MUST be arrays or objects only. A null value indicates
     * the absence of body content.
     *
     * @return null|array|object The deserialized body parameters, if any.
     *     These will typically be an array or object.
     */
    public function getParsedBody()
    {
        return $this->parsedBody;
    }

    /**
     * Return an instance with the specified body parameters.
     *
     * These MAY be injected during instantiation.
     *
     * If the request Content-Type is either application/x-www-form-urlencoded
     * or multipart/form-data, and the request method is POST, use this method
     * ONLY to inject the contents of $_POST.
     *
     * The data IS NOT REQUIRED to come from $_POST, but MUST be the results of
     * deserializing the request body content. Deserialization/parsing returns
     * structured data, and, as such, this method ONLY accepts arrays or objects,
     * or a null value if nothing was available to parse.
     *
     * As an example, if content negotiation determines that the request data
     * is a JSON payload, this method could be used to create a request
     * instance with the deserialized parameters.
     *
     * 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 body parameters.
     *
     * @param null|array|object $data The deserialized body data. This will
     *     typically be in an array or object.
     * @return static
     * @throws \InvalidArgumentException if an unsupported argument type is
     *     provided.
     */
    public function withParsedBody($data)
    {
        $self = clone $this;
        $self->parsedBody = $data;
        return $self;
    }

    /**
     * Retrieve attributes derived from the request.
     *
     * The request "attributes" may be used to allow injection of any
     * parameters derived from the request: e.g., the results of path
     * match operations; the results of decrypting cookies; the results of
     * deserializing non-form-encoded message bodies; etc. Attributes
     * will be application and request specific, and CAN be mutable.
     *
     * @return array Attributes derived from the request.
     */
    public function getAttributes()
    {
        return $this->attributes;
    }

    /**
     * Retrieve a single derived request attribute.
     *
     * Retrieves a single derived request attribute as described in
     * getAttributes(). If the attribute has not been previously set, returns
     * the default value as provided.
     *
     * This method obviates the need for a hasAttribute() method, as it allows
     * specifying a default value to return if the attribute is not found.
     *
     * @see getAttributes()
     * @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)
    {
        if(array_key_exists($name, $this->attributes))
        {
            return $this->attributes[$name];
        }
        else
        {
            return YurunHttp::getAttribute($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)
    {
        $self = clone $this;
        $self->attributes[$name] = $value;
        return $self;
    }

    /**
     * Return an instance that removes the specified derived request attribute.
     *
     * This method allows removing 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 removes
     * the attribute.
     *
     * @see getAttributes()
     * @param string $name The attribute name.
     * @return static
     */
    public function withoutAttribute($name)
    {
        $self = clone $this;
        if(array_key_exists($name, $self->attributes))
        {
            unset($self->attributes[$name]);
        }
        return $self;
    }
    
    /**
     * 设置上传的文件
     * @param self $object
     * @param \Yurun\Util\YurunHttp\Http\Psr7\UploadedFile[] $files
     * @return static
     */
    protected function setUploadedFiles(self $object, array $files)
    {
        $object->files = [];
        foreach($files as $name => $file)
        {
            if($file instanceof UploadedFile)
            {
                $object->files[$name] = $file;
            }
            else
            {
                $object->files[$name] = new UploadedFile($file['name'], $file['type'], $file['tmp_name'], $file['size'], $file['error']);
            }
        }
        return $object;
    }

    /**
     * 处理处理后的主体内容
     * @return void
     */
    protected function parseParsedBody()
    {
        // post
        if('POST' === $this->method && in_array($this->getHeaderLine(RequestHeader::CONTENT_TYPE), [
            MediaType::APPLICATION_FORM_URLENCODED,
            MediaType::MULTIPART_FORM_DATA,
        ]))
        {
            $this->parsedBody = $this->post;
        }
        // json
        else if(in_array($this->getHeaderLine(RequestHeader::CONTENT_TYPE), [
            MediaType::APPLICATION_JSON,
            MediaType::APPLICATION_JSON_UTF8,
        ]))
        {
            $this->parsedBody = json_decode($this->body, true);
        }
        // xml
        else if(in_array($this->getHeaderLine(RequestHeader::CONTENT_TYPE), [
            MediaType::TEXT_XML,
            MediaType::APPLICATION_ATOM_XML,
            MediaType::APPLICATION_RSS_XML,
            MediaType::APPLICATION_XHTML_XML,
            MediaType::APPLICATION_XML,
        ]))
        {
            $this->parsedBody = new \DOMDocument();
            $this->parsedBody->loadXML($this->body);
        }
        // 其它
        else
        {
            $this->parsedBody = (object)(string)$this->body;
        }
    }

}