HttpCacheInterceptor   A
last analyzed

Complexity

Total Complexity 5

Size/Duplication

Total Lines 22
Duplicated Lines 0 %

Importance

Changes 0
Metric Value
eloc 11
dl 0
loc 22
rs 10
c 0
b 0
f 0
wmc 5

1 Method

Rating   Name   Duplication   Size   Complexity  
A invoke() 0 17 5
1
<?php
2
3
declare(strict_types=1);
4
5
namespace BEAR\QueryRepository;
6
7
use BEAR\RepositoryModule\Annotation\AbstractCacheControl;
8
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...
9
use BEAR\RepositoryModule\Annotation\NoHttpCache;
10
use BEAR\Resource\ResourceObject;
11
use Override;
12
use Ray\Aop\MethodInterceptor;
13
use Ray\Aop\MethodInvocation;
14
15
use function assert;
16
17
final class HttpCacheInterceptor implements MethodInterceptor
18
{
19
    /**
20
     * {@inheritDoc}
21
     */
22
    #[Override]
23
    public function invoke(MethodInvocation $invocation)
24
    {
25
        $class = $invocation->getMethod()->getDeclaringClass();
26
        $attributes = $class->getAttributes(HttpCache::class);
27
        if (empty($attributes)) {
28
            $attributes = $class->getAttributes(NoHttpCache::class);
29
        }
30
31
        $cacheControl = isset($attributes[0]) ? $attributes[0]->newInstance() : null;
32
        $ro = $invocation->proceed();
33
        assert($ro instanceof ResourceObject);
34
        if ($ro->code === 200 && $cacheControl instanceof AbstractCacheControl) {
35
            $ro->headers[Header::CACHE_CONTROL] = (string) $cacheControl;
36
        }
37
38
        return $ro;
39
    }
40
}
41