SimpleSAML\SAML11\XML\ExtensionPointTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	64
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getXsiTypeNamespaceURI()	0	10	1
A	getXsiType()	0	3	1
A	getXsiTypePrefix()	0	12	1
A	getXsiTypeName()	0	10	1

<?php

declare(strict_types=1);

namespace SimpleSAML\SAML11\XML;

use RuntimeException;
use SimpleSAML\SAML11\Assert\Assert;
use SimpleSAML\XMLSchema\Type\AnyURIValue;
use SimpleSAML\XMLSchema\Type\NCNameValue;
use SimpleSAML\XMLSchema\Type\QNameValue;

use function constant;
use function defined;
use function sprintf;

/**
 * Trait for several extension points objects.
 *
 * @package simplesamlphp/saml11
 */
trait ExtensionPointTrait
{
    /**
     * @return \SimpleSAML\XMLSchema\Type\QNameValue
     */
    public function getXsiType(): QNameValue
    {
        return $this->type;
    }


    /**
     * Get the local name for the element's xsi:type.
     *
     * @return \SimpleSAML\XMLSchema\Type\NCNameValue
     */
    public static function getXsiTypeName(): NCNameValue
    {
        Assert::true(
            defined('static::XSI_TYPE_NAME'),
            self::getClassName(static::class)
            . '::XSI_TYPE_NAME constant must be defined and set to unprefixed type for the xsi:type it represents.',
            RuntimeException::class,
        );

        return NCNameValue::fromString(constant('static::XSI_TYPE_NAME'));
    }


    /**
     * Get the namespace for the element's xsi:type.
     *
     * @return \SimpleSAML\XMLSchema\Type\AnyURIValue
     */
    public static function getXsiTypeNamespaceURI(): AnyURIValue
    {
        Assert::true(
            defined('static::XSI_TYPE_NAMESPACE'),
            self::getClassName(static::class)
            . '::XSI_TYPE_NAMESPACE constant must be defined and set to the namespace for the xsi:type it represents.',
            RuntimeException::class,
        );

        return AnyURIValue::fromString(constant('static::XSI_TYPE_NAMESPACE'));
    }


    /**
     * Get the namespace-prefix for the element's xsi:type.
     *
     * @return \SimpleSAML\XMLSchema\Type\NCNameValue
     */
    public static function getXsiTypePrefix(): NCNameValue
    {
        Assert::true(
            defined('static::XSI_TYPE_PREFIX'),
            sprintf(
                '%s::XSI_TYPE_PREFIX constant must be defined and set to the namespace for the xsi:type it represents.',
                self::getClassName(static::class),
            ),
            RuntimeException::class,
        );

        return NCNameValue::fromString(constant('static::XSI_TYPE_PREFIX'));
    }
}