POData\OperationContext\Web\Illuminate\IncomingIlluminateRequest

Complexity

Total Complexity

9

Size/Duplication

Total Lines	126
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getRawUrl()	0	6	1
A	getRequestHeader()	0	10	3
A	getQueryParameters()	0	18	2
A	getMethod()	0	4	1
A	__construct()	0	8	1
A	getAllInput()	0	4	1

<?php

namespace POData\OperationContext\Web\Illuminate;

use Illuminate\Http\Request;
use POData\OperationContext\HTTPRequestMethod;
use POData\OperationContext\IHTTPRequest;

class IncomingIlluminateRequest implements IHTTPRequest
{
    /**
     * The Illuminate request.
     *
     * @var Request
     */
    private $request;

    /**
     * The request headers.
     *
     * @var array
     */
    private $_headers;

    /**
     * The incoming url in raw format.
     *
     * @var string
     */
    private $_rawUrl = null;

    /**
     * The request method (GET, POST, PUT, DELETE or MERGE).
     *
     * @var HTTPRequestMethod HttpVerb
     */
    private $_method;

    /**
     * The query options as key value.
     *
     * @var array(string, string);
     */
    private $_queryOptions;

    /**
     * A collection that represents mapping between query
     * option and its count.
     *
     * @var array(string, int)
     */
    private $_queryOptionsCount;

    /**
     * IncomingIlluminateRequest constructor.
     *
     * @param Request $request
     */
    public function __construct(Request $request)

You have injected the Request via parameter $request. This is generally not recommended as there might be multiple instances during a request cycle (f.e. when using sub-requests). Instead, it is recommended to inject the RequestStack and retrieve the current request each time you need it via getCurrentRequest().

    {
        $this->request = $request;
        $this->_headers = null;

It seems like null of type null is incompatible with the declared type array of property $_headers.

        $this->_queryOptions = null;
        $this->_queryOptionsCount = null;
        $this->_method = new HTTPRequestMethod($this->request->getMethod());
    }

    /**
     * @return string RequestURI called by User with the value of QueryString
     */
    public function getRawUrl()
    {
        $this->_rawUrl = $this->request->fullUrl();

        return $this->_rawUrl;
    }

    /**
     * @param string $key The header name
     *
     * @return array|null|string
     */
    public function getRequestHeader($key)
    {
        $result = $this->request->header($key);

The expression $this->request->header($key); of type string|array adds the type array to the return on line 91 which is incompatible with the return type declared by the interface POData\OperationContext\IHTTPRequest::getRequestHeader of type string|null.

        //Zend returns false for a missing header...POData needs a null
        if ($result === false || $result === '') {
            return null;
        }

        return $result;
    }

    /**
     * Returns the Query String Parameters (QSPs) as an array of KEY-VALUE pairs.  If a QSP appears twice
     * it will have two entries in this array.
     *
     * @return array
     */
    public function getQueryParameters()
    {
        //TODO: the contract is more specific than this, it requires the name and values to be decoded
        //not sure how to test that...
        //TODO: another issue.  This may not be the right thing to return...since POData only really understands GET requests today
        //Have to convert to the stranger format known to POData that deals with multiple query strings.
        //this makes this request a bit non compliant as it doesn't expose duplicate keys, something POData will check for
        //instead whatever parameter was last in the query string is set.  IE
        //odata.svc/?$format=xml&$format=json the format will be json
        $this->_queryOptions = [];
        $this->_queryOptionsCount = 0;
        foreach ($this->request->all() as $key => $value) {
            $this->_queryOptions[] = [$key => $value];
            ++$this->_queryOptionsCount;
        }

        return $this->_queryOptions;
    }

    /**
     * @return HTTPRequestMethod
     */
    public function getMethod()
    {
        return $this->_method;
    }

    /**
     * @return array|mixed
     */
    public function getAllInput()
    {
        return $this->request->all();
    }
}