SimpleSAML\XMLSchema\XML\xs\AbstractKeybase

Complexity

Total Complexity

7

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getSelector()	0	3	1
A	getName()	0	3	1
A	isEmptyElement()	0	3	1
A	getField()	0	3	1
A	toXML()	0	12	2
A	__construct()	0	11	1

<?php

declare(strict_types=1);

namespace SimpleSAML\XMLSchema\XML\xs;

use DOMElement;
use SimpleSAML\XML\Assert\Assert;
use SimpleSAML\XMLSchema\Exception\MissingElementException;
use SimpleSAML\XMLSchema\Type\Builtin\{IDValue, NCNameValue};

use function strval;

/**
 * Abstract class representing the keybase-type.
 *
 * @package simplesamlphp/xml-common
 */
abstract class AbstractKeybase extends AbstractAnnotated
{
    /**
     * Keybase constructor
     *
     * @param \SimpleSAML\XMLSchema\Type\Builtin\NCNameValue $name
     * @param \SimpleSAML\XMLSchema\XML\xs\Selector $selector
     * @param array<\SimpleSAML\XMLSchema\XML\xs\Field> $field
     * @param \SimpleSAML\XMLSchema\XML\xs\Annotation|null $annotation
     * @param \SimpleSAML\XMLSchema\Type\Builtin\IDValue|null $id
     * @param array<\SimpleSAML\XML\Attribute> $namespacedAttributes
     */
    public function __construct(
        protected NCNameValue $name,
        protected Selector $selector,
        protected array $field = [],
        protected ?Annotation $annotation = null,
        protected ?IDValue $id = null,
        array $namespacedAttributes = [],
    ) {
        Assert::allIsInstanceOf($field, Field::class, MissingElementException::class);

        parent::__construct($annotation, $id, $namespacedAttributes);
    }


    /**
     * Collect the value of the name-property
     *
     * @return \SimpleSAML\XMLSchema\Type\Builtin\NCNameValue
     */
    public function getName(): NCNameValue
    {
        return $this->name;
    }


    /**
     * Collect the value of the selector-property
     *
     * @return \SimpleSAML\XMLSchema\XML\xs\Selector
     */
    public function getSelector(): Selector
    {
        return $this->selector;
    }


    /**
     * Collect the value of the field-property
     *
     * @return array<\SimpleSAML\XMLSchema\XML\xs\Field>
     */
    public function getField(): array
    {
        return $this->field;
    }


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


    /**
     * Add this Keybase to an XML element.
     *
     * @param \DOMElement|null $parent The element we should append this Keybase to.
     * @return \DOMElement
     */
    public function toXML(?DOMElement $parent = null): DOMElement
    {
        $e = parent::toXML($parent);
        $e->setAttribute('name', strval($this->getName()));

        $this->getSelector()->toXML($e);

        foreach ($this->getField() as $field) {
            $field->toXML($e);
        }

        return $e;
    }
}