Completed
Pull Request — master (#67)
by Frederik
01:39
created

HeaderValueParameter   A

Complexity

Total Complexity 15

Size/Duplication

Total Lines 101
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 0

Test Coverage

Coverage 96.67%

Importance

Changes 0
Metric Value
wmc 15
lcom 1
cbo 0
dl 0
loc 101
ccs 29
cts 30
cp 0.9667
rs 10
c 0
b 0
f 0

6 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 14 4
A withSpecials() 0 6 1
A getName() 0 4 1
A getValue() 0 4 1
A __toString() 0 8 4
A fromString() 0 17 4
1
<?php
2
declare(strict_types=1);
3
4
namespace Genkgo\Mail\Header;
5
6
final class HeaderValueParameter
7
{
8
    public const RFC_822_T_SPECIAL = "\x28\x29\x3C\x3E\x40\x2C\x3B\x3A\x5C\x22\x5B\x5D\x2E";
9
    
10
    private const ANY_ASCII_EXCEPT_SPACE_CTL = "\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0A\x0B\x0C\x0D\x0E\x0F\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1A\x1B\x1C\x1D\x1E\x1F\x7F\x80\x81\x82\x83\x84\x85\x86\x87\x88\x89\x8A\x8B\x8C\x8D\x8E\x8F\x90\x91\x92\x93\x94\x95\x96\x97\x98\x99\x9A\x9B\x9C\x9D\x9E\x9F\xA0\xA1\xA2\xA3\xA4\xA5\xA6\xA7\xA8\xA9\xAA\xAB\xAC\xAD\xAE\xAF\xB0\xB1\xB2\xB3\xB4\xB5\xB6\xB7\xB8\xB9\xBA\xBB\xBC\xBD\xBE\xBF\xC0\xC1\xC2\xC3\xC4\xC5\xC6\xC7\xC8\xC9\xCA\xCB\xCC\xCD\xCE\xCF\xD0\xD1\xD2\xD3\xD4\xD5\xD6\xD7\xD8\xD9\xDA\xDB\xDC\xDD\xDE\xDF\xE0\xE1\xE2\xE3\xE4\xE5\xE6\xE7\xE8\xE9\xEA\xEB\xEC\xED\xEE\xEF\xF0\xF1\xF2\xF3\xF4\xF5\xF6\xF7\xF8\xF9\xFA\xFB\xFC\xFD\xFE\xFF";
11
12
    /**
13
     * @var string
14
     */
15
    private $name;
16
17
    /**
18
     * @var string
19
     */
20
    private $value;
21
22
    /**
23
     * @var string
24
     */
25
    private $specials = self::RFC_822_T_SPECIAL;
26
27
    /**
28
     * @param string $name
29
     * @param string $value
30
     */
31 73
    public function __construct(string $name, string $value)
32
    {
33 73
        if ($name === '' || \strcspn($name, self::ANY_ASCII_EXCEPT_SPACE_CTL) !== \strlen($name)) {
34
            throw new \InvalidArgumentException('Parameters contains incorrect name: ' . $name);
35
        }
36
37 73
        $decoded = \str_replace(OptimalEncodedHeaderValue::FOLDING, '', $value);
38 73
        if (\strcspn($decoded, self::ANY_ASCII_EXCEPT_SPACE_CTL) !== \strlen($decoded)) {
39 2
            throw new \InvalidArgumentException('Parameters contains incorrect value: ' . $value);
40
        }
41
42 71
        $this->name = $name;
43 71
        $this->value = $value;
44 71
    }
45
46
    /**
47
     * @param string $specials
48
     * @return HeaderValueParameter
49
     */
50 43
    public function withSpecials(string $specials)
51
    {
52 43
        $clone = clone $this;
53 43
        $clone->specials = $specials;
54 43
        return $clone;
55
    }
56
57
    /**
58
     * @return string
59
     */
60 70
    public function getName(): string
61
    {
62 70
        return $this->name;
63
    }
64
65
    /**
66
     * @return string
67
     */
68 30
    public function getValue(): string
69
    {
70 30
        return $this->value;
71
    }
72
73
    /**
74
     * @return string
75
     */
76 56
    public function __toString(): string
77
    {
78 56
        if ($this->value !== '' && ($this->value[0] === '=' || \strcspn($this->value, $this->specials) !== \strlen($this->value))) {
79 10
            return \sprintf('%s="%s"', $this->name, $this->value);
80
        }
81
82 52
        return \sprintf('%s=%s', $this->name, $this->value);
83
    }
84
85
    /**
86
     * @param string $parameterString
87
     * @return HeaderValueParameter
88
     */
89 26
    public static function fromString(string $parameterString): HeaderValueParameter
90
    {
91 26
        $nameValue = \explode('=', $parameterString);
92 26
        if (\count($nameValue) !== 2) {
93 1
            throw new \InvalidArgumentException(
94 1
                \sprintf('Invalid parameter string value %s', $parameterString)
95
            );
96
        }
97
98 25
        [$name, $value] = $nameValue;
0 ignored issues
show
Bug introduced by
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 by
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...
99
100 25
        if ($value[0] === '"' && $value[-1] === '"') {
0 ignored issues
show
Bug introduced by
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...
101 6
            $value = \substr($value, 1, -1);
0 ignored issues
show
Bug introduced by
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...
102
        }
103
104 25
        return new self($name, $value);
0 ignored issues
show
Bug introduced by
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

  1. 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;
        }
    }
    
  2. 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;
    }
    
  3. 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...
105
    }
106
}
107