HeaderLine::getHeader() - Code Metrics - Inspection of "WIP, upgrade to phpstan 0.12" - genkgo/mail - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#64)

by Frederik

created 2020-03-01 17:12 UTC

HeaderLine::getHeader() A

↳ Parent: HeaderLine

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	1

<?php
declare(strict_types=1);

namespace Genkgo\Mail\Header;

use Genkgo\Mail\HeaderInterface;

final class HeaderLine
{
    /**
     * @var HeaderInterface
     */
    private $header;

    /**
     * @param HeaderInterface $header
     */
    public function __construct(HeaderInterface $header)
    {
        $this->header = $header;
    }

    /**
     * @return HeaderInterface
     */
    public function getHeader(): HeaderInterface
    {
        return $this->header;
    }

    /**
     * @return string
     */
    public function __toString(): string
    {
        $headerName = (string)$this->header->getName();
        $headerValue = (string)$this->header->getValue();

        $firstFoldingAt = \strpos($headerValue, "\r\n");
        if ($firstFoldingAt === false) {
            $firstFoldingAt = \strlen($headerValue);
        }

        if (\strlen($headerName) + $firstFoldingAt > 76) {
            return \sprintf("%s:\r\n %s", $headerName, $headerValue);
        }

        return \sprintf("%s: %s", $headerName, $headerValue);
    }

    /**
     * @param string $line
     * @return HeaderLine
     */
    public static function fromString(string $line): HeaderLine
    {
        $parts = \preg_split('/\s*\:\s*/', $line, 2);

        if ($parts === false || \count($parts) !== 2) {
            throw new \InvalidArgumentException('Invalid header line');
        }

        [$name, $value] = $parts;
function someFunction() {
    $x = 5;
    echo $x;
}

        if (\substr($value, 0, 2) === '=?' && \substr($value, -2, 2) === '?=') {
function someFunction() {
    $x = 5;
    echo $x;
}
            $value = \iconv_mime_decode($value);
function someFunction() {
    $x = 5;
    echo $x;
}
            if ($value === false) {
                throw new \UnexpectedValueException('Cannot iconv decode header line');
            }
        }

        return new self(
            new ParsedHeader(
                new HeaderName($name),
                HeaderValue::fromString($value)
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
            )
        );
    }
}


1		<?php
2		declare(strict_types=1);
3
4		namespace Genkgo\Mail\Header;
5
6		use Genkgo\Mail\HeaderInterface;
7
8		final class HeaderLine
9		{
10		/**
11		* @var HeaderInterface
12		*/
13		private $header;
14
15		/**
16		* @param HeaderInterface $header
17		*/
18	76	public function __construct(HeaderInterface $header)
19		{
20	76	$this->header = $header;
21	76	}
22
23		/**
24		* @return HeaderInterface
25		*/
26	47	public function getHeader(): HeaderInterface
27		{
28	47	return $this->header;
29		}
30
31		/**
32		* @return string
33		*/
34	62	public function __toString(): string
35		{
36	62	$headerName = (string)$this->header->getName();
37	62	$headerValue = (string)$this->header->getValue();
38
39	62	$firstFoldingAt = \strpos($headerValue, "\r\n");
40	62	if ($firstFoldingAt === false) {
41	62	$firstFoldingAt = \strlen($headerValue);
42		}
43
44	62	if (\strlen($headerName) + $firstFoldingAt > 76) {
45	3	return \sprintf("%s:\r\n %s", $headerName, $headerValue);
46		}
47
48	61	return \sprintf("%s: %s", $headerName, $headerValue);
49		}
50
51		/**
52		* @param string $line
53		* @return HeaderLine
54		*/
55	49	public static function fromString(string $line): HeaderLine
56		{
57	49	$parts = \preg_split('/\s\:\s/', $line, 2);
58
59	49	if ($parts === false \|\| \count($parts) !== 2) {
60	1	throw new \InvalidArgumentException('Invalid header line');
61		}
62
63	48	[$name, $value] = $parts;
		0 ignored issues – show Bug introduced 2017-08-11 19:52 UTC by Report Bug Copy Issue Report The variable `$name` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history... Bug introduced 2017-08-11 19:52 UTC by Report Bug Copy Issue Report The variable `$value` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history...
64
65	48	if (\substr($value, 0, 2) === '=?' && \substr($value, -2, 2) === '?=') {
		0 ignored issues – show Bug introduced 2017-05-29 18:35 UTC by Report Bug Copy Issue Report The variable `$value` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history...
66	2	$value = \iconv_mime_decode($value);
		0 ignored issues – show Bug introduced 2017-05-29 18:35 UTC by Report Bug Copy Issue Report The variable `$value` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history...
67	2	if ($value === false) {
68		throw new \UnexpectedValueException('Cannot iconv decode header line');
69		}
70		}
71
72	48	return new self(
73	48	new ParsedHeader(
74	48	new HeaderName($name),
75	47	HeaderValue::fromString($value)
		0 ignored issues – show Bug introduced 2018-03-06 17:29 UTC by Report Bug Copy Issue Report The variable `$value` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
76		)
77		);
78		}
79		}
80

genkgo / mail

Pull Request — master (#64)

HeaderLine::getHeader() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like