Passed
Push — master ( c2ab36...decaf7 )
by Tim
01:44
created

ExtensionsTrait::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 1
nc 1
nop 1
dl 0
loc 3
rs 10
c 0
b 0
f 0
1
<?php
2
3
declare(strict_types=1);
4
5
namespace SimpleSAML\SAML2\XML;
6
7
use DOMElement;
8
use SimpleSAML\XML\ExtendableElementTrait;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, SimpleSAML\SAML2\XML\ExtendableElementTrait. 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
10
/**
11
 * Trait grouping common functionality for elements implementing ExtensionType.
12
 *
13
 * @package simplesamlphp/saml2
14
 */
15
trait ExtensionsTrait
16
{
17
    use ExtendableElementTrait;
18
19
20
    /**
21
     * Extensions constructor.
22
     *
23
     * @param \SimpleSAML\XML\SerializableElementInterface[] $extensions
24
     */
25
    public function __construct(array $extensions)
26
    {
27
        $this->setElements($extensions);
28
    }
29
30
31
    /**
32
     */
33
    public function isEmptyElement(): bool
34
    {
35
        if (empty($this->getElements())) {
36
            return true;
37
        }
38
39
        foreach ($this->getElements() as $extension) {
40
            if ($extension->isEmptyElement() === false) {
41
                return false;
42
            }
43
        }
44
45
        return true;
46
    }
47
48
49
    /**
50
     * Convert this object into its md:Extensions XML representation.
51
     *
52
     * @param \DOMElement|null $parent The element we should add this Extensions element to.
53
     * @return \DOMElement The new md:Extensions XML element.
54
     */
55
    public function toXML(?DOMElement $parent = null): DOMElement
56
    {
57
        $e = $this->instantiateParentElement($parent);
58
59
        if (!$this->isEmptyElement()) {
60
            foreach ($this->getElements() as $extension) {
61
                if (!$extension->isEmptyElement()) {
62
                    $extension->toXML($e);
63
                }
64
            }
65
        }
66
67
        return $e;
68
    }
69
70
71
    /**
72
     */
73
    abstract public function instantiateParentElement(?DOMElement $parent = null): DOMElement;
74
}
75