AbstractIndexedEndpointType::fromArray() - Code Metrics - Inspection of "Add validateArray method on elements they are arra..." - simplesamlphp/saml2 - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#337)

by Tim
created 2023-05-29 12:02 UTC
AbstractIndexedEndpointType::fromArray() A

↳ Parent: AbstractIndexedEndpointType
Complexity

Conditions	6
Paths	8
Size

Total Lines	27
Code Lines	19
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	6
eloc	19
nc	8
nop	1
dl	0
loc	27
rs	9.0111
c	0
b	0
f	0
<?php

declare(strict_types=1);

namespace SimpleSAML\SAML2\XML\md;

use DOMElement;
use SimpleSAML\Assert\Assert;
use SimpleSAML\SAML2\Constants as C;
use SimpleSAML\XML\ArrayizableElementInterface;
use SimpleSAML\XML\Attribute as XMLAttribute;
use SimpleSAML\XML\Chunk;
use SimpleSAML\XML\Exception\InvalidDOMElementException;
use SimpleSAML\XML\SerializableElementInterface;

use function array_filter;
use function array_key_exists;
use function array_keys;
use function is_bool;
use function strval;

/**
 * Class representing a SAML2 IndexedEndpointType.
 *
 * @package simplesamlphp/saml2
 */
abstract class AbstractIndexedEndpointType extends AbstractEndpointType implements ArrayizableElementInterface
{
    use IndexedElementTrait;


    /**
     * IndexedEndpointType constructor.
     *
     * Note: if you extend this class, the constructor must retain its signature. You cannot extend this class and
     * modify the signature of the constructor, unless you implement fromXML() yourself. This class provides
     * static methods to get its properties from a given \DOMElement for your convenience. Look at the implementation
     * of fromXML() to know how to use them.
     *
     * @param int $index
     * @param string $binding
     * @param string $location
     * @param bool|null $isDefault
     * @param string|null $responseLocation
     * @param list<\SimpleSAML\XML\Attribute> $attributes
filter:
    dependency_paths: ["lib/*"]
     * @param array $children
     */
    public function __construct(
        int $index,
        string $binding,
        string $location,
        ?bool $isDefault = null,
        ?string $responseLocation = null,
        array $attributes = [],
        array $children = [],
    ) {
        parent::__construct($binding, $location, $responseLocation, $attributes, $children);

        $this->setIndex($index);
        $this->setIsDefault($isDefault);
    }


    /**
     * Initialize an IndexedEndpointType.
     *
     * @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 any of the mandatory attributes
     */
    public static function fromXML(DOMElement $xml): static
    {
        $qualifiedName = static::getClassName(static::class);
        Assert::eq(
            $xml->localName,
            $qualifiedName,
            'Unexpected name for endpoint: ' . $xml->localName . '. Expected: ' . $qualifiedName . '.',
            InvalidDOMElementException::class,
        );

        $index = self::getIntegerAttribute($xml, 'index');
        $binding = self::getAttribute($xml, 'Binding');
        $location = self::getAttribute($xml, 'Location');

        $children = [];
        foreach ($xml->childNodes as $child) {
            if ($child->namespaceURI === C::NS_MD) {
                continue;
            } elseif (!($child instanceof DOMElement)) {
                continue;
            }

            $children[] = new Chunk($child);
        }

        return new static(
            $index,
            $binding,
            $location,
            self::getOptionalBooleanAttribute($xml, 'isDefault', null),
            self::getOptionalAttribute($xml, 'ResponseLocation', null),
            self::getAttributesNSFromXML($xml),
            $children,
        );
    }


    /**
     * Add this endpoint to an XML element.
     *
     * @param \DOMElement $parent The element we should append this endpoint to.
     * @return \DOMElement
     */
    public function toXML(DOMElement $parent = null): DOMElement
    {
        $e = parent::instantiateParentElement($parent);

        $e->setAttribute('Binding', $this->getBinding());
        $e->setAttribute('Location', $this->getLocation());
        if ($this->getResponseLocation() !== null) {
            $e->setAttribute('ResponseLocation', $this->getResponseLocation());
        }

        $e->setAttribute('index', strval($this->getIndex()));

        if (is_bool($this->getIsDefault())) {
            $e->setAttribute('isDefault', $this->getIsDefault() ? 'true' : 'false');
        }

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

        /** @var \SimpleSAML\XML\SerializableElementInterface $child */
        foreach ($this->getElements() as $child) {
            if (!$child->isEmptyElement()) {
                $child->toXML($e);
            }
        }

        return $e;
    }


    /**
     * Create a class from an array
     *
     * @param array $data
     * @return static
     */
    public static function fromArray(array $data): static
    {
        self::validateArray($data);

        $responseLocation = array_key_exists('ResponseLocation', $data) ? $data['ResponseLocation'] : null;
        $Extensions = array_key_exists('Extensions', $data) ? $data['Extensions'] : null;

        $attributes = [];
        if (array_key_exists('attributes', $data)) {
            foreach ($data['attributes'] as $attr) {
                $attributes[] = new XMLAttribute(
                    $attr['namespaceURI'],
                    $attr['namespacePrefix'],
                    $attr['attrName'],
                    $attr['attrValue'],
                );
            }
        }

        return new static(
            $data['index'],
            $data['Binding'],
            $data['Location'],
            array_key_exists('isDefault', $data) ? $data['isDefault'] : null,
            $responseLocation,
            $attributes,
            $Extensions,
            /** @scrutinizer ignore-type */ $Extensions,
        );
    }


    /**
     * Validate an array
     *
     * @param array $data
     * @return void
     */
    public static function validateArray(array $data): void
    {
        // Make sure the array keys are known for this kind of object
        Assert::allOneOf(
            array_keys($data),
            ['index', 'Binding', 'Location', 'isDefault', 'ResponseLocation', 'attributes', 'Extensions'],
        );

        // Make sure all the mandatory items exist
        Assert::keyExists($data, 'Binding');
        Assert::keyExists($data, 'Location');
        Assert::keyExists($data, 'index');

        // Make sure the items have the correct data type
        Assert::integer($data['index']);
        Assert::range($data['index'], 0, 65535);
        Assert::string($data['Binding']);
        Assert::string($data['Location']);

        if (array_key_exists('isDefault', $data)) {
            Assert::boolean($data['isDefault']);
        }

        if (array_key_exists('ResponseLocation', $data)) {
            Assert::string($data['ResponseLocation']);
        }

        if (array_key_exists('attributes', $data)) {
            Assert::isArray($data['attributes']);
            Assert::allIsArray($data['attributes']);
            foreach ($data['attributes'] as $attr) {
                XMLAttribute::validateArray($attr);
            }
        }

        if (array_key_exists('Extensions', $data)) {
            Assert::isArray($data['Extensions']);
            Assert::allIsInstanceOf($data['Extensions'], SerializableElementInterface::class);
        }
    }


    /**
     * Create an array from this class
     *
     * @return array
     */
    public function toArray(): array
    {
        $data = parent::toArray();
        $data['index'] = $this->getIndex();
        $data['isDefault'] = $this->getIsDefault();

        return array_filter($data);
    }
}

simplesamlphp / saml2

Pull Request — master (#337)

AbstractIndexedEndpointType::fromArray() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
