SapiEmitter::filterHeader() - Code Metrics - Mosaic/Http - Measure and Improve Code Quality continuously with Scrutinizer

SapiEmitter::filterHeader() A
last analyzed 2016-07-16 11:40 UTC

↳ Parent: SapiEmitter

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	7
ccs	4
cts	4
cp	1
rs	9.4285
cc	1
eloc	4
nc	1
nop	1
crap	1

<?php

namespace Mosaic\Http\Emitters;

use Mosaic\Http\Emitter;
use Psr\Http\Message\ResponseInterface;
use RuntimeException;

class SapiEmitter implements Emitter
{
    /**
     * @param ResponseInterface $response
     * @param null              $maxBufferLevel
     *
     * @throws RuntimeException
     */
    public function emit(ResponseInterface $response, $maxBufferLevel = null)
    {
        if (headers_sent()) {
            throw new RuntimeException('Unable to emit response. Headers were already sent');
        }

        if (!$response->hasHeader('Content-Length')) {
            // PSR-7 indicates int OR null for the stream size; for null values,
            // we will not auto-inject the Content-Length.
            if (null !== $response->size()) {
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                $response = $response->addHeader('Content-Length', (string) $response->size());
            }
        }

        $this->emitStatus($response);
        $this->emitHeaders($response);
        $this->emitBody($response, $maxBufferLevel);
    }

    /**
     * @param Response $response
     */
    private function emitStatus(ResponseInterface $response)
    {
        $reasonPhrase = $response->reason();


        header(sprintf(
            'HTTP/%s %d%s',
            $response->protocol(),

            $response->status(),

            ($reasonPhrase ? ' ' . $reasonPhrase : '')
        ));
    }

    /**
     * @param ResponseInterface $response
     */
    private function emitHeaders(ResponseInterface $response)
    {
        foreach ($response->headers() as $header => $values) {

            $name  = $this->filterHeader($header);
            $first = true;
            foreach ($values as $value) {
                header(sprintf(
                    '%s: %s',
                    $name,
                    $value
                ), $first);
                $first = false;
            }
        }
    }

    /**
     * @param ResponseInterface $response
     * @param                   $maxBufferLevel
     */
    private function emitBody(ResponseInterface $response, $maxBufferLevel)
    {
        if (null === $maxBufferLevel) {
            $maxBufferLevel = ob_get_level();
        }

        while (ob_get_level() > $maxBufferLevel) {
            ob_end_flush();
        }

        echo $response->body();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * Filter a header name to wordcase
     *
     * @param string $header
     *
     * @return string
     */
    private function filterHeader($header)
    {
        $filtered = str_replace('-', ' ', $header);
        $filtered = ucwords($filtered);

        return str_replace(' ', '-', $filtered);
    }
}


1		<?php
2
3		namespace Mosaic\Http\Emitters;
4
5		use Mosaic\Http\Emitter;
6		use Psr\Http\Message\ResponseInterface;
7		use RuntimeException;
8
9		class SapiEmitter implements Emitter
10		{
11		/**
12		* @param ResponseInterface $response
13		* @param null $maxBufferLevel
14		*
15		* @throws RuntimeException
16		*/
17	7	public function emit(ResponseInterface $response, $maxBufferLevel = null)
18		{
19	7	if (headers_sent()) {
20	1	throw new RuntimeException('Unable to emit response. Headers were already sent');
21		}
22
23	6	if (!$response->hasHeader('Content-Length')) {
24		// PSR-7 indicates int OR null for the stream size; for null values,
25		// we will not auto-inject the Content-Length.
26	2	if (null !== $response->size()) {
		0 ignored issues – show Bug introduced 2016-03-15 11:35 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Psr\Http\Message\ResponseInterface` as the method `size()` does only exist in the following implementations of said interface: `Mosaic\Http\Adapters\Psr7\Response`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
27	1	$response = $response->addHeader('Content-Length', (string) $response->size());
28		}
29		}
30
31	6	$this->emitStatus($response);
32	6	$this->emitHeaders($response);
33	6	$this->emitBody($response, $maxBufferLevel);
34	6	}
35
36		/**
37		* @param Response $response
38		*/
39	6	private function emitStatus(ResponseInterface $response)
40		{
41	6	$reasonPhrase = $response->reason();
		0 ignored issues – show Bug introduced 2016-03-15 11:35 UTC by Report Bug Copy Issue Report The method `reason()` does not exist on `Psr\Http\Message\ResponseInterface`. Did you maybe mean `getReasonPhrase()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
42
43	6	header(sprintf(
44	6	'HTTP/%s %d%s',
45	6	$response->protocol(),
		0 ignored issues – show Bug introduced 2016-03-15 11:35 UTC by Report Bug Copy Issue Report The method `protocol()` does not exist on `Psr\Http\Message\ResponseInterface`. Did you maybe mean `getProtocolVersion()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
46	6	$response->status(),
		0 ignored issues – show Bug introduced 2016-03-15 11:35 UTC by Report Bug Copy Issue Report The method `status()` does not exist on `Psr\Http\Message\ResponseInterface`. Did you maybe mean `getStatusCode()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
47	6	($reasonPhrase ? ' ' . $reasonPhrase : '')
48		));
49	6	}
50
51		/**
52		* @param ResponseInterface $response
53		*/
54	6	private function emitHeaders(ResponseInterface $response)
55		{
56	6	foreach ($response->headers() as $header => $values) {
		0 ignored issues – show Bug introduced 2016-03-15 11:35 UTC by Report Bug Copy Issue Report The method `headers()` does not exist on `Psr\Http\Message\ResponseInterface`. Did you maybe mean `getHeaders()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
57	1	$name = $this->filterHeader($header);
58	1	$first = true;
59	1	foreach ($values as $value) {
60	1	header(sprintf(
61	1	'%s: %s',
62		$name,
63		$value
64		), $first);
65	1	$first = false;
66		}
67		}
68	6	}
69
70		/**
71		* @param ResponseInterface $response
72		* @param $maxBufferLevel
73		*/
74	6	private function emitBody(ResponseInterface $response, $maxBufferLevel)
75		{
76	6	if (null === $maxBufferLevel) {
77	4	$maxBufferLevel = ob_get_level();
78		}
79
80	6	while (ob_get_level() > $maxBufferLevel) {
81	1	ob_end_flush();
82		}
83
84	6	echo $response->body();
		0 ignored issues – show Bug introduced 2016-03-15 11:35 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Psr\Http\Message\ResponseInterface` as the method `body()` does only exist in the following implementations of said interface: `Mosaic\Http\Adapters\Psr7\Response`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
85	6	}
86
87		/**
88		* Filter a header name to wordcase
89		*
90		* @param string $header
91		*
92		* @return string
93		*/
94	1	private function filterHeader($header)
95		{
96	1	$filtered = str_replace('-', ' ', $header);
97	1	$filtered = ucwords($filtered);
98
99	1	return str_replace(' ', '-', $filtered);
100		}
101		}
102

Mosaic / Http

SapiEmitter::filterHeader() A last analyzed 2016-07-16 11:40 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

SapiEmitter::filterHeader() A
last analyzed 2016-07-16 11:40 UTC