1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
declare(strict_types=1); |
4
|
|
|
|
5
|
|
|
namespace SimpleSAML\XMLSecurity\XML\ds; |
6
|
|
|
|
7
|
|
|
use DOMElement; |
8
|
|
|
use SimpleSAML\Assert\Assert; |
9
|
|
|
use SimpleSAML\XML\Chunk; |
10
|
|
|
use SimpleSAML\XML\Exception\InvalidDOMElementException; |
11
|
|
|
|
12
|
|
|
/** |
13
|
|
|
* Class representing a ds:Transform element. |
14
|
|
|
* |
15
|
|
|
* @package simplesamlphp/xml-security |
16
|
|
|
*/ |
17
|
|
|
final class Transform extends AbstractDsElement |
18
|
|
|
{ |
19
|
|
|
/** @var \SimpleSAML\XML\Chunk[] */ |
20
|
|
|
protected array $elements = []; |
21
|
|
|
|
22
|
|
|
/** @var string */ |
23
|
|
|
protected string $Algorithm; |
24
|
|
|
|
25
|
|
|
|
26
|
|
|
/** |
27
|
|
|
* Initialize a ds:Transform |
28
|
|
|
* |
29
|
|
|
* @param \SimpleSAML\XML\Chunk[] $elements |
30
|
|
|
* @param string $Algorithm |
31
|
|
|
*/ |
32
|
|
|
public function __construct(array $elements = [], string $Algorithm = 'http://www.w3.org/TR/1999/REC-xpath-19991116') |
33
|
|
|
{ |
34
|
|
|
$this->setElements($elements); |
35
|
|
|
$this->setAlgorithm($Algorithm); |
36
|
|
|
} |
37
|
|
|
|
38
|
|
|
|
39
|
|
|
/** |
40
|
|
|
* @return string |
41
|
|
|
*/ |
42
|
|
|
public function getAlgorithm(): string |
43
|
|
|
{ |
44
|
|
|
return $this->Algorithm; |
45
|
|
|
} |
46
|
|
|
|
47
|
|
|
|
48
|
|
|
/** |
49
|
|
|
* @param string $Algorithm |
50
|
|
|
* @throws \SimpleSAML\Assert\AssertionFailedException |
51
|
|
|
*/ |
52
|
|
|
protected function setAlgorithm(string $Algorithm): void |
53
|
|
|
{ |
54
|
|
|
Assert::notEmpty($Algorithm, 'Cannot set an empty algorithm in ' . static::NS_PREFIX . ':Transform.'); |
55
|
|
|
$this->Algorithm = $Algorithm; |
56
|
|
|
} |
57
|
|
|
|
58
|
|
|
|
59
|
|
|
/** |
60
|
|
|
* Collect the elements |
61
|
|
|
* |
62
|
|
|
* @return \SimpleSAML\XML\Chunk[] |
63
|
|
|
*/ |
64
|
|
|
public function getElements(): array |
65
|
|
|
{ |
66
|
|
|
return $this->elements; |
67
|
|
|
} |
68
|
|
|
|
69
|
|
|
|
70
|
|
|
/** |
71
|
|
|
* Set the value of the elements-property |
72
|
|
|
* |
73
|
|
|
* @param \SimpleSAML\XML\Chunk[] $elements |
74
|
|
|
* @throws \SimpleSAML\Assert\AssertionFailedException if the supplied array contains anything other than Chunk objects |
75
|
|
|
*/ |
76
|
|
|
private function setElements(array $elements): void |
77
|
|
|
{ |
78
|
|
|
Assert::allIsInstanceOf($elements, Chunk::class); |
79
|
|
|
|
80
|
|
|
$this->elements = $elements; |
81
|
|
|
} |
82
|
|
|
|
83
|
|
|
|
84
|
|
|
/** |
85
|
|
|
* Test if an object, at the state it's in, would produce an empty XML-element |
86
|
|
|
* |
87
|
|
|
* @return bool |
88
|
|
|
*/ |
89
|
|
|
public function isEmptyElement(): bool |
90
|
|
|
{ |
91
|
|
|
return empty($this->elements); |
92
|
|
|
} |
93
|
|
|
|
94
|
|
|
|
95
|
|
|
/** |
96
|
|
|
* Convert XML into a Transform element |
97
|
|
|
* |
98
|
|
|
* @param \DOMElement $xml The XML element we should load |
99
|
|
|
* @return self |
100
|
|
|
* |
101
|
|
|
* @throws \SimpleSAML\XML\Exception\InvalidDOMElementException |
102
|
|
|
* If the qualified name of the supplied element is wrong |
103
|
|
|
*/ |
104
|
|
|
public static function fromXML(DOMElement $xml): object |
105
|
|
|
{ |
106
|
|
|
Assert::same($xml->localName, 'Transform', InvalidDOMElementException::class); |
107
|
|
|
Assert::same($xml->namespaceURI, Transform::NS, InvalidDOMElementException::class); |
108
|
|
|
|
109
|
|
|
$Algorithm = self::getAttribute($xml, 'Algorithm'); |
110
|
|
|
|
111
|
|
|
$elements = []; |
112
|
|
|
foreach ($xml->childNodes as $element) { |
113
|
|
|
if (!($element instanceof DOMElement)) { |
114
|
|
|
continue; |
115
|
|
|
} |
116
|
|
|
|
117
|
|
|
$elements[] = new Chunk($element); |
118
|
|
|
} |
119
|
|
|
|
120
|
|
|
return new self($elements, $Algorithm); |
121
|
|
|
} |
122
|
|
|
|
123
|
|
|
|
124
|
|
|
/** |
125
|
|
|
* Convert this Transform element to XML. |
126
|
|
|
* |
127
|
|
|
* @param \DOMElement|null $parent The element we should append this Transform element to. |
128
|
|
|
* @return \DOMElement |
129
|
|
|
*/ |
130
|
|
|
public function toXML(DOMElement $parent = null): DOMElement |
131
|
|
|
{ |
132
|
|
|
$e = $this->instantiateParentElement($parent); |
133
|
|
|
$e->setAttribute('Algorithm', $this->Algorithm); |
134
|
|
|
|
135
|
|
|
foreach ($this->elements as $element) { |
136
|
|
|
$e->appendChild($e->ownerDocument->importNode($element->getXML(), true)); |
|
|
|
|
137
|
|
|
} |
138
|
|
|
|
139
|
|
|
return $e; |
140
|
|
|
} |
141
|
|
|
} |
142
|
|
|
|
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.