ContactPerson::toXML() - Code Metrics - Inspection of "Bump xml-common" - simplesamlphp/saml2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( c66cd3...78be34 )

by Tim

created 2023-05-19 19:06 UTC

ContactPerson::toXML() A

↳ Parent: ContactPerson

Complexity

Conditions	4
Paths	8

Size

Total Lines	24
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	13
nc	8
nop	1
dl	0
loc	24
rs	9.8333
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace SimpleSAML\SAML2\XML\md;

use DOMDocument;
use DOMElement;
use Exception;
use SimpleSAML\Assert\Assert;
use SimpleSAML\SAML2\Exception\ProtocolViolationException;
use SimpleSAML\SAML2\Utils\XPath;
use SimpleSAML\SAML2\XML\ExtendableElementTrait;
use SimpleSAML\XML\ArrayizableElementInterface;
use SimpleSAML\XML\Attribute as XMLAttribute;
use SimpleSAML\XML\Constants as C;
use SimpleSAML\XML\Exception\InvalidDOMElementException;
use SimpleSAML\XML\Exception\TooManyElementsException;
use SimpleSAML\XML\ExtendableAttributesTrait;
use SimpleSAML\XML\Utils as XMLUtils;

use function array_key_exists;
use function array_map;
use function array_pop;
use function count;
use function filter_var;
use function preg_replace;
use function var_export;

/**
 * Class representing SAML 2 ContactPerson.
 *
 * @package simplesamlphp/saml2
 */
final class ContactPerson extends AbstractMdElement implements ArrayizableElementInterface
{
    use ExtendableAttributesTrait;

    use ExtendableElementTrait;

    /** The namespace-attribute for the xs:anyAttribute element */
    public const XS_ANY_ATTR_NAMESPACE = C::XS_ANY_NS_OTHER;


    /**
     * The several different contact types as defined per specification
     */
    public const CONTACT_TYPES = [
        'technical',
        'support',
        'administrative',
        'billing',
        'other',
    ];


    /**
     * ContactPerson constructor.
     *
     * @param string $contactType
     * @param \SimpleSAML\SAML2\XML\md\Company|null $company
     * @param \SimpleSAML\SAML2\XML\md\GivenName|null $givenName
     * @param \SimpleSAML\SAML2\XML\md\SurName|null $surName
     * @param \SimpleSAML\SAML2\XML\md\Extensions|null $extensions
     * @param \SimpleSAML\SAML2\XML\md\EmailAddress[] $emailAddress
     * @param \SimpleSAML\SAML2\XML\md\TelephoneNumber[] $telephoneNumber
     * @param list<\SimpleSAML\XML\Attribute> $namespacedAttribute
filter:
    dependency_paths: ["lib/*"]
     */
    public function __construct(
        protected string $contactType,
        protected ?Company $company = null,
        protected ?GivenName $givenName = null,
        protected ?SurName $surName = null,
        ?Extensions $extensions = null,
        protected array $emailAddress = [],
        protected array $telephoneNumber = [],
        array $namespacedAttribute = [],
    ) {
        Assert::oneOf($contactType, self::CONTACT_TYPES);
        Assert::allIsInstanceOf($emailAddress, EmailAddress::class);
        Assert::allIsInstanceOf($telephoneNumber, TelephoneNumber::class);

        $this->setExtensions($extensions);
        $this->setAttributesNS($namespacedAttribute);
    }


    /**
     * Collect the value of the contactType-property
     *
     * @return string
     */
    public function getContactType(): string
    {
        return $this->contactType;
    }


    /**
     * Collect the value of the Company-property
     *
     * @return \SimpleSAML\SAML2\XML\md\Company|null
     */
    public function getCompany(): ?Company
    {
        return $this->company;
    }


    /**
     * Collect the value of the GivenName-property
     *
     * @return \SimpleSAML\SAML2\XML\md\GivenName|null
     */
    public function getGivenName(): ?GivenName
    {
        return $this->givenName;
    }


    /**
     * Collect the value of the SurName-property
     *
     * @return \SimpleSAML\SAML2\XML\md\SurName|null
     */
    public function getSurName(): ?SurName
    {
        return $this->surName;
    }


    /**
     * Collect the value of the EmailAddress-property.
     *
     * @return \SimpleSAML\SAML2\XML\md\EmailAddress[]
     */
    public function getEmailAddress(): array
    {
        return $this->emailAddress;
    }


    /**
     * Collect the value of the TelephoneNumber property
     *
     * @return \SimpleSAML\SAML2\XML\md\TelephoneNumber[]
     */
    public function getTelephoneNumber(): array
    {
        return $this->telephoneNumber;
    }


    /**
     * Initialize a ContactPerson element.
     *
     * @param \DOMElement $xml The XML element we should load.
     * @return static
     *
     * @throws \SimpleSAML\XML\Exception\InvalidDOMElementException
     *   if the qualified name of the supplied element is wrong
     * @throws \SimpleSAML\XML\Exception\MissingAttributeException
     *   if the supplied element is missing one of the mandatory attributes
     * @throws \SimpleSAML\XML\Exception\TooManyElementsException
     *   if too many child-elements of a type are specified
     */
    public static function fromXML(DOMElement $xml): static
    {
        Assert::same($xml->localName, 'ContactPerson', InvalidDOMElementException::class);
        Assert::same($xml->namespaceURI, ContactPerson::NS, InvalidDOMElementException::class);

        $contactType = self::getAttribute($xml, 'contactType');

        $company = Company::getChildrenOfClass($xml);
        Assert::maxCount($company, 1, 'More than one Company in md:ContactPerson');

        $givenName = GivenName::getChildrenOfClass($xml);
        Assert::maxCount($givenName, 1, 'More than one GivenName in md:ContactPerson');

        $surName = SurName::getChildrenOfClass($xml);
        Assert::maxCount($surName, 1, 'More than one SurName in md:ContactPerson');

        $email = EmailAddress::getChildrenOfClass($xml);
        $telephone = TelephoneNumber::getChildrenOfClass($xml);

        $extensions = Extensions::getChildrenOfClass($xml);
        Assert::maxCount($extensions, 1, 'Only one md:Extensions element is allowed.', TooManyElementsException::class);

        return new static(
            $contactType,
            array_pop($company),
            array_pop($givenName),
            array_pop($surName),
            (count($extensions) === 1) ? $extensions[0] : null,
            $email,
            $telephone,
            self::getAttributesNSFromXML($xml),
        );
    }


    /**
     * Convert this ContactPerson to XML.
     *
     * @param \DOMElement|null $parent The element we should add this contact to.
     *
     * @return \DOMElement The new ContactPerson-element.
     */
    public function toXML(DOMElement $parent = null): DOMElement
    {
        $e = $this->instantiateParentElement($parent);

        $e->setAttribute('contactType', $this->getContactType());

        foreach ($this->getAttributesNS() as $attr) {
            $attr->toXML($e);
        }

        $this->getExtensions()?->toXML($e);
        $this->getCompany()?->toXML($e);
        $this->getGivenName()?->toXML($e);
        $this->getSurName()?->toXML($e);

        foreach ($this->getEmailAddress() as $mail) {
            $mail->toXML($e);
        }

        foreach ($this->getTelephoneNumber() as $telephone) {
            $telephone->toXML($e);
        }

        return $e;
    }


    /**
     * Create a class from an array
     *
     * @param array $data
     * @return static
     */
    public static function fromArray(array $data): static
    {
        Assert::keyExists($data, 'ContactType');

        $ContactType = $data['ContactType'];
        $Company = isset($data['Company']) ? new Company($data['Company']) : null;
        $GivenName = isset($data['GivenName']) ? new GivenName($data['GivenName']) : null;
        $SurName = isset($data['SurName']) ? new SurName($data['SurName']) : null;
        $Extensions = $data['Extensions'] ?? null;

        $EmailAddress = [];
        if (array_key_exists('EmailAddress', $data)) {
            foreach ($data['EmailAddress'] as $mail) {
                $EmailAddress[] = new EmailAddress($mail);
            }
        }

        $TelephoneNumber = [];
        if (array_key_exists('TelephoneNumber', $data)) {
            foreach ($data['TelephoneNumber'] as $telephone) {
                $TelephoneNumber[] = new TelephoneNumber($telephone);
            }
        }

        $attributes = [];
        if (array_key_exists('attributes', $data)) {
            foreach ($data['attributes'] as $attr) {
                Assert::keyExists($attr, 'namespaceURI');
                Assert::keyExists($attr, 'namespacePrefix');
                Assert::keyExists($attr, 'attrName');
                Assert::keyExists($attr, 'attrValue');

                $attributes[] = new XMLAttribute(
                    $attr['namespaceURI'],
                    $attr['namespacePrefix'],
                    $attr['attrName'],
                    $attr['attrValue'],
                );
            }
        }

        return new static(
            $ContactType,
            $Company,
            $GivenName,
            $SurName,
            $Extensions,
            $EmailAddress,
            $TelephoneNumber,
            $attributes,
        );
    }


    /**
     * Create an array from this class
     *
     * @return array
     */
    public function toArray(): array
    {
        $data = [
            'ContactType' => $this->getContactType(),
            'Company' => $this->getCompany()?->getContent(),
            'GivenName' => $this->getGivenName()?->getContent(),
            'SurName' => $this->getSurName()?->getContent(),
            'EmailAddress' => [],
            'TelephoneNumber' => [],
            'Extensions' => $this->Extensions,
            'attributes' => [],
        ];

        foreach ($this->getEmailAddress() as $mail) {
            $data['EmailAddress'] = array_merge($data['EmailAddress'], $mail->toArray());
        }

        foreach ($this->getTelephoneNumber() as $telephone) {
            $data['TelephoneNumber'] = array_merge($data['TelephoneNumber'], $telephone->toArray());
        }

        foreach ($this->getAttributesNS() as $attr) {
            $data['attributes'][] = $attr->toArray();
        }

        return $data;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace SimpleSAML\SAML2\XML\md;
6
7			use DOMDocument;
8			use DOMElement;
9			use Exception;
10			use SimpleSAML\Assert\Assert;
11			use SimpleSAML\SAML2\Exception\ProtocolViolationException;
12			use SimpleSAML\SAML2\Utils\XPath;
13			use SimpleSAML\SAML2\XML\ExtendableElementTrait;
14			use SimpleSAML\XML\ArrayizableElementInterface;
15			use SimpleSAML\XML\Attribute as XMLAttribute;
16			use SimpleSAML\XML\Constants as C;
17			use SimpleSAML\XML\Exception\InvalidDOMElementException;
18			use SimpleSAML\XML\Exception\TooManyElementsException;
19			use SimpleSAML\XML\ExtendableAttributesTrait;
20			use SimpleSAML\XML\Utils as XMLUtils;
21
22			use function array_key_exists;
23			use function array_map;
24			use function array_pop;
25			use function count;
26			use function filter_var;
27			use function preg_replace;
28			use function var_export;
29
30			/**
31			* Class representing SAML 2 ContactPerson.
32			*
33			* @package simplesamlphp/saml2
34			*/
35			final class ContactPerson extends AbstractMdElement implements ArrayizableElementInterface
36			{
37			use ExtendableAttributesTrait;
			1 ignored issue – show introduced 2023-05-19 19:18 UTC by Report Bug Copy Issue Report The trait `SimpleSAML\XML\ExtendableAttributesTrait` requires some properties which are not provided by `SimpleSAML\SAML2\XML\md\ContactPerson`: `$localName`, `$nodeValue`, `$namespaceURI`, `$prefix`, `$attributes` Loading history...
38			use ExtendableElementTrait;
39
40			/** The namespace-attribute for the xs:anyAttribute element */
41			public const XS_ANY_ATTR_NAMESPACE = C::XS_ANY_NS_OTHER;
42
43
44			/**
45			* The several different contact types as defined per specification
46			*/
47			public const CONTACT_TYPES = [
48			'technical',
49			'support',
50			'administrative',
51			'billing',
52			'other',
53			];
54
55
56			/**
57			* ContactPerson constructor.
58			*
59			* @param string $contactType
60			* @param \SimpleSAML\SAML2\XML\md\Company\|null $company
61			* @param \SimpleSAML\SAML2\XML\md\GivenName\|null $givenName
62			* @param \SimpleSAML\SAML2\XML\md\SurName\|null $surName
63			* @param \SimpleSAML\SAML2\XML\md\Extensions\|null $extensions
64			* @param \SimpleSAML\SAML2\XML\md\EmailAddress[] $emailAddress
65			* @param \SimpleSAML\SAML2\XML\md\TelephoneNumber[] $telephoneNumber
66			* @param list<\SimpleSAML\XML\Attribute> $namespacedAttribute
			0 ignored issues – show Bug introduced 2023-05-19 19:18 UTC by Report Bug Copy Issue Report The type `SimpleSAML\SAML2\XML\md\list` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
67			*/
68			public function __construct(
69			protected string $contactType,
70			protected ?Company $company = null,
71			protected ?GivenName $givenName = null,
72			protected ?SurName $surName = null,
73			?Extensions $extensions = null,
74			protected array $emailAddress = [],
75			protected array $telephoneNumber = [],
76			array $namespacedAttribute = [],
77			) {
78			Assert::oneOf($contactType, self::CONTACT_TYPES);
79			Assert::allIsInstanceOf($emailAddress, EmailAddress::class);
80			Assert::allIsInstanceOf($telephoneNumber, TelephoneNumber::class);
81
82			$this->setExtensions($extensions);
83			$this->setAttributesNS($namespacedAttribute);
84			}
85
86
87			/**
88			* Collect the value of the contactType-property
89			*
90			* @return string
91			*/
92			public function getContactType(): string
93			{
94			return $this->contactType;
95			}
96
97
98			/**
99			* Collect the value of the Company-property
100			*
101			* @return \SimpleSAML\SAML2\XML\md\Company\|null
102			*/
103			public function getCompany(): ?Company
104			{
105			return $this->company;
106			}
107
108
109			/**
110			* Collect the value of the GivenName-property
111			*
112			* @return \SimpleSAML\SAML2\XML\md\GivenName\|null
113			*/
114			public function getGivenName(): ?GivenName
115			{
116			return $this->givenName;
117			}
118
119
120			/**
121			* Collect the value of the SurName-property
122			*
123			* @return \SimpleSAML\SAML2\XML\md\SurName\|null
124			*/
125			public function getSurName(): ?SurName
126			{
127			return $this->surName;
128			}
129
130
131			/**
132			* Collect the value of the EmailAddress-property.
133			*
134			* @return \SimpleSAML\SAML2\XML\md\EmailAddress[]
135			*/
136			public function getEmailAddress(): array
137			{
138			return $this->emailAddress;
139			}
140
141
142			/**
143			* Collect the value of the TelephoneNumber property
144			*
145			* @return \SimpleSAML\SAML2\XML\md\TelephoneNumber[]
146			*/
147			public function getTelephoneNumber(): array
148			{
149			return $this->telephoneNumber;
150			}
151
152
153			/**
154			* Initialize a ContactPerson element.
155			*
156			* @param \DOMElement $xml The XML element we should load.
157			* @return static
158			*
159			* @throws \SimpleSAML\XML\Exception\InvalidDOMElementException
160			* if the qualified name of the supplied element is wrong
161			* @throws \SimpleSAML\XML\Exception\MissingAttributeException
162			* if the supplied element is missing one of the mandatory attributes
163			* @throws \SimpleSAML\XML\Exception\TooManyElementsException
164			* if too many child-elements of a type are specified
165			*/
166			public static function fromXML(DOMElement $xml): static
167			{
168			Assert::same($xml->localName, 'ContactPerson', InvalidDOMElementException::class);
169			Assert::same($xml->namespaceURI, ContactPerson::NS, InvalidDOMElementException::class);
170
171			$contactType = self::getAttribute($xml, 'contactType');
172
173			$company = Company::getChildrenOfClass($xml);
174			Assert::maxCount($company, 1, 'More than one Company in md:ContactPerson');
175
176			$givenName = GivenName::getChildrenOfClass($xml);
177			Assert::maxCount($givenName, 1, 'More than one GivenName in md:ContactPerson');
178
179			$surName = SurName::getChildrenOfClass($xml);
180			Assert::maxCount($surName, 1, 'More than one SurName in md:ContactPerson');
181
182			$email = EmailAddress::getChildrenOfClass($xml);
183			$telephone = TelephoneNumber::getChildrenOfClass($xml);
184
185			$extensions = Extensions::getChildrenOfClass($xml);
186			Assert::maxCount($extensions, 1, 'Only one md:Extensions element is allowed.', TooManyElementsException::class);
187
188			return new static(
189			$contactType,
190			array_pop($company),
191			array_pop($givenName),
192			array_pop($surName),
193			(count($extensions) === 1) ? $extensions[0] : null,
194			$email,
195			$telephone,
196			self::getAttributesNSFromXML($xml),
197			);
198			}
199
200
201			/**
202			* Convert this ContactPerson to XML.
203			*
204			* @param \DOMElement\|null $parent The element we should add this contact to.
205			*
206			* @return \DOMElement The new ContactPerson-element.
207			*/
208			public function toXML(DOMElement $parent = null): DOMElement
209			{
210			$e = $this->instantiateParentElement($parent);
211
212			$e->setAttribute('contactType', $this->getContactType());
213
214			foreach ($this->getAttributesNS() as $attr) {
215			$attr->toXML($e);
216			}
217
218			$this->getExtensions()?->toXML($e);
219			$this->getCompany()?->toXML($e);
220			$this->getGivenName()?->toXML($e);
221			$this->getSurName()?->toXML($e);
222
223			foreach ($this->getEmailAddress() as $mail) {
224			$mail->toXML($e);
225			}
226
227			foreach ($this->getTelephoneNumber() as $telephone) {
228			$telephone->toXML($e);
229			}
230
231			return $e;
232			}
233
234
235			/**
236			* Create a class from an array
237			*
238			* @param array $data
239			* @return static
240			*/
241			public static function fromArray(array $data): static
242			{
243			Assert::keyExists($data, 'ContactType');
244
245			$ContactType = $data['ContactType'];
246			$Company = isset($data['Company']) ? new Company($data['Company']) : null;
247			$GivenName = isset($data['GivenName']) ? new GivenName($data['GivenName']) : null;
248			$SurName = isset($data['SurName']) ? new SurName($data['SurName']) : null;
249			$Extensions = $data['Extensions'] ?? null;
250
251			$EmailAddress = [];
252			if (array_key_exists('EmailAddress', $data)) {
253			foreach ($data['EmailAddress'] as $mail) {
254			$EmailAddress[] = new EmailAddress($mail);
255			}
256			}
257
258			$TelephoneNumber = [];
259			if (array_key_exists('TelephoneNumber', $data)) {
260			foreach ($data['TelephoneNumber'] as $telephone) {
261			$TelephoneNumber[] = new TelephoneNumber($telephone);
262			}
263			}
264
265			$attributes = [];
266			if (array_key_exists('attributes', $data)) {
267			foreach ($data['attributes'] as $attr) {
268			Assert::keyExists($attr, 'namespaceURI');
269			Assert::keyExists($attr, 'namespacePrefix');
270			Assert::keyExists($attr, 'attrName');
271			Assert::keyExists($attr, 'attrValue');
272
273			$attributes[] = new XMLAttribute(
274			$attr['namespaceURI'],
275			$attr['namespacePrefix'],
276			$attr['attrName'],
277			$attr['attrValue'],
278			);
279			}
280			}
281
282			return new static(
283			$ContactType,
284			$Company,
285			$GivenName,
286			$SurName,
287			$Extensions,
288			$EmailAddress,
289			$TelephoneNumber,
290			$attributes,
291			);
292			}
293
294
295			/**
296			* Create an array from this class
297			*
298			* @return array
299			*/
300			public function toArray(): array
301			{
302			$data = [
303			'ContactType' => $this->getContactType(),
304			'Company' => $this->getCompany()?->getContent(),
305			'GivenName' => $this->getGivenName()?->getContent(),
306			'SurName' => $this->getSurName()?->getContent(),
307			'EmailAddress' => [],
308			'TelephoneNumber' => [],
309			'Extensions' => $this->Extensions,
310			'attributes' => [],
311			];
312
313			foreach ($this->getEmailAddress() as $mail) {
314			$data['EmailAddress'] = array_merge($data['EmailAddress'], $mail->toArray());
315			}
316
317			foreach ($this->getTelephoneNumber() as $telephone) {
318			$data['TelephoneNumber'] = array_merge($data['TelephoneNumber'], $telephone->toArray());
319			}
320
321			foreach ($this->getAttributesNS() as $attr) {
322			$data['attributes'][] = $attr->toArray();
323			}
324
325			return $data;
326			}
327			}
328

simplesamlphp / saml2

Push — master ( c66cd3...78be34 )

ContactPerson::toXML() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like