Completed
Push — ezp25875-richtext_image_embed_... ( e4c65d...20ab85 )
by
unknown
19:52
created

IsEmbedImage::match()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 14
Code Lines 7

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 1
Metric Value
cc 3
eloc 7
c 1
b 0
f 1
nc 3
nop 1
dl 0
loc 14
rs 9.4285
1
<?php
2
/**
3
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
4
 * @license For full copyright and license information view LICENSE file distributed with this source code.
5
 */
6
namespace eZ\Publish\Core\MVC\Symfony\Matcher\ContentBased;
7
8
use eZ\Publish\Core\MVC\Symfony\View\View;
9
use eZ\Publish\Core\MVC\Symfony\Matcher\ViewMatcherInterface;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, eZ\Publish\Core\MVC\Symf...ed\ViewMatcherInterface.

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...
10
use InvalidArgumentException;
11
12
/**
13
 * A view matcher that matches embed images using embed object parameter.
14
 */
15
class IsEmbedImage implements ViewMatcherInterface
16
{
17
    /**
18
     * @var bool
19
     */
20
    private $isImage;
21
22
    public function setMatchingConfig($matchingConfig)
23
    {
24
        if (!is_bool($matchingConfig)) {
25
            throw new InvalidArgumentException('The IsEmbedImage matcher expects a boolean value');
26
        }
27
28
        $this->isImage = $matchingConfig;
29
    }
30
31
    public function match(View $view)
32
    {
33
        if (!$view->hasParameter('objectParameters')) {
34
            return false;
35
        }
36
37
        $objectParameters = $view->getParameter('objectParameters');
38
39
        if (!isset($objectParameters['isImage'])) {
40
            return false;
41
        }
42
43
        return $objectParameters['isImage'] === $this->isImage;
44
    }
45
}
46