SimpleSAML\XML\Type\AbstractValueType

Complexity

Total Complexity

9

Size/Duplication

Total Lines	119
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	normalizeWhitespace()	0	3	1
A	getValue()	0	3	1
A	__construct()	0	4	1
A	validateValue()	0	2	1
A	__toString()	0	3	1
A	fromString()	0	3	1
A	collapseWhitespace()	0	3	1
A	sanitizeValue()	0	7	1
A	getRawValue()	0	3	1

<?php

declare(strict_types=1);

namespace SimpleSAML\XML\Type;

use function preg_replace;
use function trim;

/**
 * Abstract class to be implemented by all types
 *
 * @package simplesamlphp/xml-common
 */
abstract class AbstractValueType implements ValueTypeInterface
{
    /** @var string */
    public const SCHEMA_TYPE = 'anySimpleType';

    /** @var string */
    public const SCHEMA_NAMESPACEURI = 'http://www.w3.org/2001/XMLSchema';

    /** @var string */
    public const SCHEMA_NAMESPACE_PREFIX = 'xs';


    /**
     * Set the value for this type.
     *
     * @param string $value
     */
    final protected function __construct(
        protected string $value,
    ) {
        $this->validateValue($value);
    }


    /**
     * Get the value.
     *
     * @return string
     */
    public function getValue(): string
    {
        return $this->sanitizeValue($this->getRawValue());
    }


    /**
     * Get the raw unsanitized value.
     *
     * @return string
     */
    public function getRawValue(): string
    {
        return $this->value;
    }


    /**
     * Sanitize the value.
     *
     * @param string $value  The value
     * @throws \Exception on failure
     * @return string
     */
    protected function sanitizeValue(string $value): string
    {
        /**
         * Perform no sanitation by default.
         * Override this method on the implementing class to perform content sanitation.
         */
        return $value;
    }


    /**
     * Validate the value.
     *
     * @param string $value  The value
     * @throws \Exception on failure
     * @return void
     */
    protected function validateValue(/** @scrutinizer-ignore */string $value): void
    {
        /**
         * Perform no validation by default.
         * Override this method on the implementing class to perform validation.
         */
    }


    /**
     * Normalize whitespace in the value
     *
     * @return string
     */
    protected static function normalizeWhitespace(string $value): string
    {
        return preg_replace('/\s/', ' ', $value);
    }


    /**
     * Collapse whitespace
     *
     * @return string
     */
    protected static function collapseWhitespace(string $value): string
    {
        return trim(preg_replace('/\s+/', ' ', $value));
    }


    /**
     * @param string $value
     * @return static
     */
    public static function fromString(string $value): static
    {
        return new static($value);
    }


    /**
     * Output the value as a string
     *
     * @return string
     */
    public function __toString(): string
    {
        return $this->getValue();
    }
}