Passed
Pull Request — master (#196)
by Sergei
02:31
created

Delete   A

Complexity

Total Complexity 2

Size/Duplication

Total Lines 36
Duplicated Lines 0 %

Test Coverage

Coverage 100%

Importance

Changes 1
Bugs 0 Features 0
Metric Value
eloc 13
c 1
b 0
f 0
dl 0
loc 36
ccs 13
cts 13
cp 1
rs 10
wmc 2

2 Methods

Rating   Name   Duplication   Size   Complexity  
A getRoute() 0 3 1
A __construct() 0 18 1
1
<?php
2
3
declare(strict_types=1);
4
5
namespace Yiisoft\Router\Attribute;
6
7
use Attribute;
8
use Stringable;
9
use Yiisoft\Http\Method;
10
use Yiisoft\Router\Route;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, Yiisoft\Router\Attribute\Route. 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...
11
12
#[Attribute(Attribute::TARGET_METHOD | Attribute::TARGET_CLASS | Attribute::IS_REPEATABLE)]
13
final class Delete implements RouteAttributeInterface
14
{
15
    private Route $route;
16
17
    /**
18
     * @param array<string,scalar|Stringable|null> $defaults Parameter default values indexed by parameter names.
19
     * @param bool $override Marks route as override. When added it will replace existing route with the same name.
20
     * @param array $disabledMiddlewares Excludes middleware from being invoked when action is handled.
21
     * It is useful to avoid invoking one of the parent group middleware for
22
     * a certain route.
23
     */
24 2
    public function __construct(
25
        string $pattern,
26
        ?string $name = null,
27
        array $middlewares = [],
28
        array $defaults = [],
29
        array $hosts = [],
30
        bool $override = false,
31
        array $disabledMiddlewares = []
32
    ) {
33 2
        $this->route = new Route(
34 2
            methods: [Method::DELETE],
35 2
            pattern: $pattern,
36 2
            name: $name,
37 2
            middlewares: $middlewares,
38 2
            defaults: $defaults,
39 2
            hosts: $hosts,
40 2
            override: $override,
41 2
            disabledMiddlewares: $disabledMiddlewares
42 2
        );
43
    }
44
45 2
    public function getRoute(): Route
46
    {
47 2
        return $this->route;
48
    }
49
}
50