simplesamlphp / saml2

src/XML/mdrpi/PublicationPath.php

<?php

declare(strict_types=1);

namespace SimpleSAML\SAML2\XML\mdrpi;

use DOMElement;
use SimpleSAML\SAML2\Assert\Assert;
use SimpleSAML\SAML2\Exception\ArrayValidationException;
use SimpleSAML\XML\ArrayizableElementInterface;
use SimpleSAML\XML\Constants as C;

The type SimpleSAML\XML\Constants was not found. Maybe you did not declare it correctly or list all dependencies?

use SimpleSAML\XML\SchemaValidatableElementInterface;
use SimpleSAML\XML\SchemaValidatableElementTrait;
use SimpleSAML\XMLSchema\Exception\InvalidDOMElementException;

/**
 * Class for handling the mdrpi:PublicationPath element.
 *
 * @link: http://docs.oasis-open.org/security/saml/Post2.0/saml-metadata-rpi/v1.0/saml-metadata-rpi-v1.0.pdf
 *
 * @package simplesamlphp/saml2
 */
final class PublicationPath extends AbstractMdrpiElement implements

The type SimpleSAML\SAML2\XML\mdrpi\AbstractMdrpiElement was not found. Maybe you did not declare it correctly or list all dependencies?

    ArrayizableElementInterface,
    SchemaValidatableElementInterface
{
    use SchemaValidatableElementTrait;


    /**
     * Create/parse a mdrpi:PublicationPath element.
     *
     * @param \SimpleSAML\SAML2\XML\mdrpi\Publication[] $publication
     */
    public function __construct(
        protected array $publication = [],
    ) {
        Assert::maxCount($publication, C::UNBOUNDED_LIMIT);
        Assert::allIsInstanceOf($publication, Publication::class);
    }


    /**
     * Collect the value of the Publication-property
     *
     * @return \SimpleSAML\SAML2\XML\mdrpi\Publication[]
     */
    public function getPublication(): array
    {
        return $this->publication;
    }


    /**
     * Test if an object, at the state it's in, would produce an empty XML-element
     */
    public function isEmptyElement(): bool
    {
        return empty($this->publication);
    }


    /**
     * Convert XML into a PublicationPath
     *
     * @param \DOMElement $xml The XML element we should load
     * @return static
     *
     * @throws \SimpleSAML\XMLSchema\Exception\InvalidDOMElementException
     *   if the qualified name of the supplied element is wrong
     * @throws \SimpleSAML\XMLSchema\Exception\MissingAttributeException
     *   if the supplied element is missing one of the mandatory attributes
     */
    public static function fromXML(DOMElement $xml): static
    {
        Assert::same($xml->localName, 'PublicationPath', InvalidDOMElementException::class);
        Assert::same($xml->namespaceURI, PublicationPath::NS, InvalidDOMElementException::class);

        $Publication = Publication::getChildrenOfClass($xml);

        return new static($Publication);
    }


    /**
     * Convert this element to XML.
     */
    public function toXML(?DOMElement $parent = null): DOMElement
    {
        $e = $this->instantiateParentElement($parent);

        foreach ($this->getPublication() as $pub) {
            $pub->toXML($e);
        }

        return $e;
    }


    /**
     * Create a class from an array
     *
     * @param array{array} $data

The doc comment array{array} at position 2 could not be parsed: Expected ':' at position 2, but found 'array'.

     */
    public static function fromArray(array $data): static
    {
        Assert::allIsArray($data, ArrayValidationException::class);

        $publication = [];
        foreach ($data as $p) {
            $publication[] = Publication::fromArray($p);
        }

        return new static($publication);
    }


    /**
     * Create an array from this class
     *
     * @return array{array}

The doc comment array{array} at position 2 could not be parsed: Expected ':' at position 2, but found 'array'.

     */
    public function toArray(): array
    {
        $data = [];
        foreach ($this->getPublication() as $p) {
            $data[] = $p->toArray();
        }

        return $data;
    }
}