Passed
Pull Request — 1.x (#99)
by Akihito
10:41
created

HeaderSetter::__invoke()   A

Complexity

Conditions 3
Paths 2

Size

Total Lines 6
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 3
eloc 3
c 1
b 0
f 0
nc 2
nop 3
dl 0
loc 6
rs 10
1
<?php
2
3
declare(strict_types=1);
4
5
namespace BEAR\QueryRepository;
6
7
use BEAR\RepositoryModule\Annotation\HttpCache;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, BEAR\QueryRepository\HttpCache. Consider defining an alias.

Let?s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let?s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
8
use BEAR\Resource\ResourceObject;
9
10
use function is_int;
11
use function sprintf;
12
use function strpos;
13
14
final class HeaderSetter
15
{
16
    /** @var EtagSetterInterface */
17
    private $etagSetter;
18
19
    public function __construct(EtagSetterInterface $etagSetter)
20
    {
21
        $this->etagSetter = $etagSetter;
22
    }
23
24
    public function __invoke(ResourceObject $ro, ?int $concheControlMaxAge, ?HttpCache $httpCache): void
25
    {
26
        ($this->etagSetter)($ro, null, $httpCache);
27
28
        if (is_int($concheControlMaxAge) && $concheControlMaxAge > 0) {
29
            $this->setCacheControlMaxAge($ro, $concheControlMaxAge);
30
        }
31
    }
32
33
    private function setCacheControlMaxAge(ResourceObject $ro, int $age): void
34
    {
35
        $setMaxAge = sprintf('max-age=%d', $age);
36
        $hasNoCacheControleHeader = ! isset($ro->headers[Header::CACHE_CONTROL]);
37
        $headers = $ro->headers;
38
        if ($hasNoCacheControleHeader) {
39
            $ro->headers[Header::CACHE_CONTROL] = $setMaxAge;
40
41
            return;
42
        }
43
44
        $isMaxAgeAlreadyDefined = strpos($headers[Header::CACHE_CONTROL], 'max-age') !== false;
45
        if ($isMaxAgeAlreadyDefined) {
46
            return;
47
        }
48
49
        if (isset($ro->headers[Header::CACHE_CONTROL])) {
50
            $ro->headers[Header::CACHE_CONTROL] .= ', ' . $setMaxAge;
51
        }
52
    }
53
}
54