Borobudur\Http\AbstractRequest

Complexity

Total Complexity

18

Size/Duplication

Total Lines	267
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes	2
Bugs	0	Features	0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	setContent()	0	6	1
A	getServerBag()	0	4	1
A	getHeaderBag()	0	4	1
A	getParameterBag()	0	4	1
A	getQueryBag()	0	4	1
A	getSession()	0	4	1
A	getCookieBag()	0	4	1
A	getFileBag()	0	4	1
A	getSchemaHost()	0	4	1
A	getUri()	0	4	1
A	getUrl()	0	4	1
A	getMethod()	0	4	1
A	setMethod()	0	6	1
A	isXmlHttpRequest()	0	4	1
A	getContent()	0	8	2
A	isMethod()	0	4	1
A	isReadOnly()	0	4	1

<?php
/*
 * This file is part of the Borobudur-Http package.
 *
 * (c) Hexacodelabs <http://hexacodelabs.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Borobudur\Http;

use Borobudur\Http\Session;

/**
 * @author      Iqbal Maulana <iq.bluejack@gmail.com>
 * @created     8/5/15
 */
abstract class AbstractRequest
{
    /**
     * Server and $_SERVER environment parameters.
     *
     * @var ServerBag
     */
    protected $server;

    /**
     * $_POST parameters.
     *
     * @var ParameterBag
     */
    protected $request;

    /**
     * $_FILES parameters.
     *
     * @var UploadFileBag
     */
    protected $files;

    /**
     * $_GET parameters.
     *
     * @var ParameterBag
     */
    protected $query;

    /**
     * $_COOKIE parameters.
     *
     * @var ParameterBag
     */
    protected $cookies;

    /**
     * Headers from $_SERVER.
     *
     * @var HeaderBag
     */
    protected $headers;

    /**
     * Request URI.
     *
     * @var Uri
     */
    protected $uri;

    /**
     * @var Url
     */
    protected $url;

    /**
     * @var SchemaHost
     */
    protected $schemaHost;

    /**
     * @var Session
     */
    protected $session;

    /**
     * @var string
     */
    protected $content;

    /**
     * List of safe methods (read only).
     *
     * @var array
     */
    protected static $safeMethods = array(
        Request::HTTP_METHOD_GET,
        Request::HTTP_METHOD_HEAD,
    );

    /**
     * Get server bag.
     *
     * @return ServerBag
     */
    public function getServerBag()
    {
        return $this->server;
    }

    /**
     * Get header bag.
     *
     * @return HeaderBag
     */
    public function getHeaderBag()
    {
        return $this->headers;
    }

    /**
     * Get request parameter bag.
     *
     * @return ParameterBag
     */
    public function getParameterBag()
    {
        return $this->request;
    }

    /**
     * Get query bag.
     *
     * @return ParameterBag
     */
    public function getQueryBag()
    {
        return $this->query;
    }

    /**
     * Get session.
     *
     * @return Session
     */
    public function getSession()
    {
        return $this->session;
    }

    /**
     * Get cookie bag.
     *
     * @return ParameterBag
     */
    public function getCookieBag()
    {
        return $this->cookies;
    }

    /**
     * Get file bag.
     *
     * @return UploadFileBag
     */
    public function getFileBag()
    {
        return $this->files;
    }

    /**
     * Get schema and host.
     *
     * @return SchemaHost
     */
    public function getSchemaHost()
    {
        return $this->schemaHost;
    }

    /**
     * Get uri component.
     *
     * @return Uri
     */
    public function getUri()
    {
        return $this->uri;
    }

    /**
     * Get url.
     *
     * @return Url
     */
    public function getUrl()
    {
        return $this->url;
    }

    /**
     * Get HTTP method.
     *
     * Return GET method as default.
     *
     * @return string
     */
    public function getMethod()
    {
        return $this->server->get('REQUEST_METHOD', Request::HTTP_METHOD_GET);
    }

    /**
     * Set HTTP method.
     *
     * @param string $method
     *
     * @return $this
     */
    public function setMethod($method)
    {
        $this->server->set('REQUEST_METHOD', strtoupper($method));

        return $this;
    }

    /**
     * Check if request is Xml Http Request or not.
     *
     * @return bool
     */
    public function isXmlHttpRequest()
    {
        return 'xmlhttprequest' === strtolower($this->server->get('HTTP_X_REQUESTED_WITH'));
    }

    /**
     * Get request body content.
     *
     * @return resource|string
     */
    public function getContent()
    {
        if (null === $this->content) {
            $this->content = file_get_contents('php://input');
        }

        return $this->content;
    }

    /**
     * Set request content.
     *
     * @param string $content
     *
     * @return $this
     */
    public function setContent($content)
    {
        $this->content = $content;

        return $this;
    }

    /**
     * Check if request method is of specified type.
     *
     * @param string $method
     *
     * @return bool
     */
    public function isMethod($method)
    {
        return strtoupper($method) === $this->getMethod();
    }

    /**
     * Check if request method is read only.
     *
     * @return bool
     */
    public function isReadOnly()
    {
        return in_array($this->getMethod(), static::$safeMethods);
    }
}