HasHeader::toString()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 0
Metric Value
eloc 1
c 1
b 0
f 0
dl 0
loc 3
ccs 2
cts 2
cp 1
rs 10
cc 1
nc 1
nop 0
crap 1
1
<?php declare(strict_types=1);
2
3
namespace Pitchart\Phlunit\Constraint\HttpResponse;
4
5
use PHPUnit\Framework\Constraint\Constraint;
6
use Psr\Http\Message\ResponseInterface;
7
8
final class HasHeader extends Constraint
9
{
10
    /**
11
     * @var int|string
12
     */
13
    private $key;
14
15
    /**
16
     * @param int|string $key
17
     */
18 10
    public function __construct($key)
19
    {
20 10
        $this->key = $key;
21 10
    }
22
23
    /**
24
     * Returns a string representation of the constraint.
25
     *
26
     * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
27
     *
28
     * @return string
29
     */
30 1
    public function toString(): string
31
    {
32 1
        return 'has the header ' . $this->exporter()->export($this->key);
33
    }
34
35
    /**
36
     * Evaluates the constraint for parameter $other. Returns true if the
37
     * constraint is met, false otherwise.
38
     *
39
     * @param mixed $other value or object to evaluate
40
     */
41 7
    protected function matches($other): bool
42
    {
43 7
        if ($other instanceof ResponseInterface) {
44 6
            return \array_key_exists($this->key, $other->getHeaders());
45
        }
46
47 1
        return false;
48
    }
49
50
    /**
51
     * Returns the description of the failure
52
     *
53
     * The beginning of failure messages is "Failed asserting that" in most
54
     * cases. This method should return the second part of that sentence.
55
     *
56
     * @param mixed $other evaluated value or object
57
     *
58
     * @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
59
     *
60
     * @return string
61
     */
62 1
    protected function failureDescription($other): string
63
    {
64 1
        return 'a HTTP Response ' . $this->toString();
65
    }
66
}
67