Passed
Pull Request — master (#73)
by Daniel
06:20
created

ComponentPositionValidator   A

Complexity

Total Complexity 3

Size/Duplication

Total Lines 14
Duplicated Lines 0 %

Test Coverage

Coverage 0%

Importance

Changes 1
Bugs 0 Features 0
Metric Value
eloc 7
c 1
b 0
f 0
dl 0
loc 14
ccs 0
cts 7
cp 0
rs 10
wmc 3

1 Method

Rating   Name   Duplication   Size   Complexity  
A validate() 0 8 3
1
<?php
2
3
/*
4
 * This file is part of the Silverback API Components Bundle Project
5
 *
6
 * (c) Daniel West <[email protected]>
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
declare(strict_types=1);
13
14
namespace Silverback\ApiComponentsBundle\Validator\Constraints;
15
16
use Silverback\ApiComponentsBundle\Entity\Core\ComponentPosition;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, Silverback\ApiComponents...aints\ComponentPosition. 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...
17
use Silverback\ApiComponentsBundle\Validator\Constraints\ComponentPosition as ComponentPositionConstraint;
18
use Symfony\Component\Validator\Constraint;
19
use Symfony\Component\Validator\ConstraintValidator;
20
21
/**
22
 * @author Daniel West <[email protected]>
23
 */
24
class ComponentPositionValidator extends ConstraintValidator
25
{
26
    /**
27
     * @param ComponentPosition           $componentPosition
28
     * @param ComponentPositionConstraint $constraint
29
     */
30
    public function validate($componentPosition, Constraint $constraint): void
31
    {
32
        $collection = $componentPosition->componentCollection;
33
        if (($allowed = $collection->allowedComponents) && !$allowed->contains($className = \get_class($componentPosition->component))) {
34
            $this->context->buildViolation($constraint->message)
35
                ->setParameter('{{ component }}', $className)
36
                ->setParameter('{{ reference }}', $collection->reference)
37
                ->addViolation();
38
        }
39
    }
40
}
41