HeaderSetter::setCacheControlMaxAge()   A
last analyzed

Complexity

Conditions 4
Paths 4

Size

Total Lines 18
Code Lines 11

Duplication

Lines 0
Ratio 0 %

Importance

Changes 2
Bugs 0 Features 0
Metric Value
cc 4
eloc 11
c 2
b 0
f 0
nc 4
nop 2
dl 0
loc 18
rs 9.9
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 str_contains;
13
14
final class HeaderSetter
15
{
16
    public function __construct(
17
        private readonly EtagSetterInterface $etagSetter,
18
    ) {
19
    }
20
21
    public function __invoke(ResourceObject $ro, int|null $concheControlMaxAge, HttpCache|null $httpCache): void
22
    {
23
        ($this->etagSetter)($ro, null, $httpCache);
24
25
        if (is_int($concheControlMaxAge) && $concheControlMaxAge > 0) {
26
            $this->setCacheControlMaxAge($ro, $concheControlMaxAge);
27
        }
28
    }
29
30
    private function setCacheControlMaxAge(ResourceObject $ro, int $age): void
31
    {
32
        $setMaxAge = sprintf('max-age=%d', $age);
33
        $hasNoCacheControleHeader = ! isset($ro->headers[Header::CACHE_CONTROL]);
34
        $headers = $ro->headers;
35
        if ($hasNoCacheControleHeader) {
36
            $ro->headers[Header::CACHE_CONTROL] = $setMaxAge;
37
38
            return;
39
        }
40
41
        $isMaxAgeAlreadyDefined = str_contains($headers[Header::CACHE_CONTROL], 'max-age');
42
        if ($isMaxAgeAlreadyDefined) {
43
            return;
44
        }
45
46
        if (isset($ro->headers[Header::CACHE_CONTROL])) {
47
            $ro->headers[Header::CACHE_CONTROL] .= ', ' . $setMaxAge;
48
        }
49
    }
50
}
51