Passed
Pull Request — master (#2)
by Tim
01:58
created

AbstractSignedXMLElement::toXML()   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\XMLSecurity\XML;
6
7
use DOMElement;
8
use SimpleSAML\XMLSecurity\XML\ds\Signature;
9
10
/**
11
 * Abstract class to be implemented by all signed classes
12
 *
13
 * @package simplesamlphp/xml-security
14
 */
15
abstract class AbstractSignedXMLElement implements SignedElementInterface
16
{
17
    use SignedElementTrait;
18
19
    /**
20
     * The signed DOM structure.
21
     *
22
     * @var \DOMElement
23
     */
24
    protected DOMElement $structure;
25
26
    /**
27
     * The unsigned elelement.
28
     *
29
     * @var \SimpleSAML\XMLSecurity\XML\SignableElementInterface
30
     */
31
    protected SignableElementInterface $element;
32
33
34
    /**
35
     * Create/parse an alg:SigningMethod element.
36
     *
37
     * @param \DOMElement $xml
38
     * @param \SimpleSAML\XMLSecurity\XML\SignableElementInterface $elt
39
     * @param \SimpleSAML\XMLSecurity\XML\ds\Signature $signature
40
     */
41
    protected function __construct(DOMElement $xml, SignableElementInterface $elt, Signature $signature)
42
    {
43
        $this->setStructure($xml);
44
        $this->setElement($elt);
45
        $this->setSignature($signature);
46
    }
47
48
49
    /**
50
     * Output the class as an XML-formatted string
51
     *
52
     * @return string
53
     */
54
    public function __toString(): string
55
    {
56
        return $this->structure->ownerDocument->saveXML();
0 ignored issues
show
Bug introduced by
The method saveXML() does not exist on null. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-call  annotation

56
        return $this->structure->ownerDocument->/** @scrutinizer ignore-call */ saveXML();

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
57
    }
58
59
60
    /**
61
     * Collect the value of the unsigned element
62
     *
63
     * @return \SimpleSAML\XMLSecurity\XML\SignableElementInterface
64
     */
65
    public function getElement(): SignableElementInterface
66
    {
67
        return $this->element;
68
    }
69
70
71
    /**
72
     * Set the value of the elment-property
73
     *
74
     * @param \SimpleSAML\XMLSecurity\XML\SignableElementInterface $elt
75
     */
76
    private function setElement(SignableElementInterface $elt): void
77
    {
78
        $this->element = $elt;
79
    }
80
81
82
    /**
83
     * Collect the value of the structure-property
84
     *
85
     * @return \DOMElement
86
     */
87
    public function getStructure(): DOMElement
88
    {
89
        return $this->structure;
90
    }
91
92
93
    /**
94
     * Set the value of the structure-property
95
     *
96
     * @param \DOMElement $structure
97
     */
98
    private function setStructure(DOMElement $structure): void
99
    {
100
        $this->structure = $structure;
101
    }
102
103
104
    /**
105
     * Create XML from this class
106
     *
107
     * @param \DOMElement|null $parent
108
     * @return \DOMElement
109
     */
110
    public function toXML(DOMElement $parent = null): DOMElement
0 ignored issues
show
Unused Code introduced by
The parameter $parent is not used and could be removed. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-unused  annotation

110
    public function toXML(/** @scrutinizer ignore-unused */ DOMElement $parent = null): DOMElement

This check looks for parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
111
    {
112
        return $this->structure;
113
    }
114
115
116
    /**
117
     * Create a class from XML
118
     *
119
     * @param \DOMElement $xml
120
     * @return self
121
     */
122
    abstract public static function fromXML(DOMElement $xml): object;
123
}
124