AbstractHttpAdapter::importHeaders() - Code Metrics - Inspection of "API Add fromPsr7 method, update tests and readme" - robbieaverill/psr7-adapters - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 704539...2a5253 )

by Robbie

created 2017-01-15 02:15 UTC

AbstractHttpAdapter::importHeaders() A

↳ Parent: AbstractHttpAdapter

Complexity

Conditions	3
Paths	3

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0
nc	3
cc	3
eloc	4
nop	2

<?php

namespace Robbie\Psr7;

use Psr\Http\Message\MessageInterface;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Control\HTTPResponse;

/**
 * Provides common functionality used between Request and Response objects
 *
 * @package psr7-adapters
 */
abstract class AbstractHttpAdapter
{
    /**
     * @var string
     */
    protected $protocolVersion;

    /**
     * Perform a conversion from a HTTPResponse or HTTPRequest into the corresponding PSR-7 interface
     *
     * @param  HTTPRequest|HTTPResponse $input
     * @return MessageInterface
     */
    abstract public function toPsr7($input);

    /**
     * Perform a conversion from a PSR-7 interface to the corresponding HTTPRequest or HTTPResponse class
     *
     * @param  MessageInterface $input
     * @return HTTPRequest|HTTPResponse
     */
    abstract public function fromPsr7($input);

    /**
     * PSR-7 interfaces support multiple headers per type, whereas SilverStripe classes do not.
     *
     * This method will assign headers as a comma delimited string from the PSR-7 interface to the SilverStripe class
     *
     * @param MessageInterface         $from
     * @param HTTPRequest|HTTPResponse $to
     */
    public function importHeaders(MessageInterface $from, $to)
    {
        foreach ($from->getHeaders() as $key => $headers) {
            foreach ($headers as $header) {
                $to->addHeader($key, $from->getHeaderLine($key));
            }
        }
    }

    /**
     * Get the protocol version - either from a previously set value, or from the server
     *
     * @return string E.g. "1.1"
     */
    public function getProtocolVersion()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if ($this->protocolVersion) {
            return $this->protocolVersion;
        }

        $protocolAndVersion = $_SERVER['SERVER_PROTOCOL'];
        list($protocol, $version) = explode('/', $protocolAndVersion);
<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;
        return $version;
    }

    /**
     * Set the protocol version
     *
     * @param  string $version
     * @return $this
     */
    public function setProtocolVersion($version = '1.1')
    {
        $this->protocolVersion = $version;
        return $this;
    }
}


1			<?php
2
3			namespace Robbie\Psr7;
4
5			use Psr\Http\Message\MessageInterface;
6			use SilverStripe\Control\HTTPRequest;
7			use SilverStripe\Control\HTTPResponse;
8
9			/**
10			* Provides common functionality used between Request and Response objects
11			*
12			* @package psr7-adapters
13			*/
14			abstract class AbstractHttpAdapter
15			{
16			/**
17			* @var string
18			*/
19			protected $protocolVersion;
20
21			/**
22			* Perform a conversion from a HTTPResponse or HTTPRequest into the corresponding PSR-7 interface
23			*
24			* @param HTTPRequest\|HTTPResponse $input
25			* @return MessageInterface
26			*/
27			abstract public function toPsr7($input);
28
29			/**
30			* Perform a conversion from a PSR-7 interface to the corresponding HTTPRequest or HTTPResponse class
31			*
32			* @param MessageInterface $input
33			* @return HTTPRequest\|HTTPResponse
34			*/
35			abstract public function fromPsr7($input);
36
37			/**
38			* PSR-7 interfaces support multiple headers per type, whereas SilverStripe classes do not.
39			*
40			* This method will assign headers as a comma delimited string from the PSR-7 interface to the SilverStripe class
41			*
42			* @param MessageInterface $from
43			* @param HTTPRequest\|HTTPResponse $to
44			*/
45			public function importHeaders(MessageInterface $from, $to)
46			{
47			foreach ($from->getHeaders() as $key => $headers) {
48			foreach ($headers as $header) {
49			$to->addHeader($key, $from->getHeaderLine($key));
50			}
51			}
52			}
53
54			/**
55			* Get the protocol version - either from a previously set value, or from the server
56			*
57			* @return string E.g. "1.1"
58			*/
59			public function getProtocolVersion()
			0 ignored issues – show Coding Style introduced 2017-01-13 06:06 UTC by Report Bug Copy Issue Report `getProtocolVersion` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
60			{
61			if ($this->protocolVersion) {
62			return $this->protocolVersion;
63			}
64
65			$protocolAndVersion = $_SERVER['SERVER_PROTOCOL'];
66			list($protocol, $version) = explode('/', $protocolAndVersion);
			0 ignored issues – show Unused Code introduced 2017-01-13 06:06 UTC by Report Bug Copy Issue Report The assignment to `$protocol` is unused. Consider omitting it like so `list($first,,$third)`. This checks looks for assignemnts to variables using the `list(...)` function, where not all assigned variables are subsequently used. Consider the following code example. <?php function returnThreeValues() { return array('a', 'b', 'c'); } list($a, $b, $c) = returnThreeValues(); print $a . " - " . $c; Only the variables `$a` and `$c` are used. There was no need to assign `$b`. Instead, the list call could have been. list($a,, $c) = returnThreeValues(); Loading history...
67			return $version;
68			}
69
70			/**
71			* Set the protocol version
72			*
73			* @param string $version
74			* @return $this
75			*/
76			public function setProtocolVersion($version = '1.1')
77			{
78			$this->protocolVersion = $version;
79			return $this;
80			}
81			}
82

robbieaverill / psr7-adapters

Push — master ( 704539...2a5253 )

AbstractHttpAdapter::importHeaders() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like