SimpleSAML\XML\TypedTextContentTrait

Complexity

Total Complexity

5

Size/Duplication

Total Lines	59
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
A	toXML()	0	6	1
A	__construct()	0	3	1
A	getTextContentType()	0	10	2
A	fromXML()	0	9	1

<?php

declare(strict_types=1);

namespace SimpleSAML\XML;

use DOMElement;
use SimpleSAML\XML\Assert\Assert;
use SimpleSAML\XML\Exception\{InvalidDOMElementException, InvalidValueTypeException};
use SimpleSAML\XML\Type\{ValueTypeInterface, StringValue};

use function defined;
use function strval;

/**
 * Trait for elements that hold a typed textContent value.
 *
 * @package simplesaml/xml-common
 */
trait TypedTextContentTrait
{
    /**
     * @param \SimpleSAML\XML\Type\ValueTypeInterface $content
     */
    public function __construct(
        protected ValueTypeInterface $content,
    ) {
    }


    /**
     * Create a class from XML
     *
     * @param \DOMElement $xml
     * @return static
     */
    public static function fromXML(DOMElement $xml): static
    {
        Assert::same($xml->localName, static::getLocalName(), InvalidDOMElementException::class);
        Assert::same($xml->namespaceURI, static::NS, InvalidDOMElementException::class);

The constant SimpleSAML\XML\TypedTextContentTrait::NS was not found. Maybe you did not declare it correctly or list all dependencies?

        $type = self::getTextContentType();
        $text = $type::fromString($xml->textContent);

        return new static($text);
    }


    /**
     * Create XML from this class
     *
     * @param \DOMElement|null $parent
     * @return \DOMElement
     */
    public function toXML(?DOMElement $parent = null): DOMElement
    {
        $e = $this->instantiateParentElement($parent);

It seems like instantiateParentElement() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $e->textContent = strval($this->getContent());

It seems like getContent() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $e;
    }


    /**
     * Get the type the element's textContent value.
     *
     * @return class-string

The doc comment class-string at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string.

     */
    public static function getTextContentType(): string
    {
        if (defined('static::TEXTCONTENT_TYPE')) {
            $type = static::TEXTCONTENT_TYPE;

The constant SimpleSAML\XML\TypedTextContentTrait::TEXTCONTENT_TYPE was not found. Maybe you did not declare it correctly or list all dependencies?

        } else {
            $type = StringValue::class;
        }

        Assert::isAOf($type, ValueTypeInterface::class, InvalidValueTypeException::class);
        return $type;
    }
}