SimpleSAML\XML\Type\BooleanValue

Complexity

Total Complexity

6

Size/Duplication

Total Lines	51
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	sanitizeValue()	0	3	1
A	validateValue()	0	4	1
A	fromBoolean()	0	4	2
A	toBoolean()	0	4	2

<?php

declare(strict_types=1);

namespace SimpleSAML\XML\Type;

use SimpleSAML\XML\Assert\Assert;
use SimpleSAML\XML\Exception\SchemaViolationException;

use function boolval;
use function in_array;
use function strval;

/**
 * @package simplesaml/xml-common
 */
class BooleanValue extends AbstractValueType
{
    /** @var string */
    public const SCHEMA_TYPE = 'boolean';


    /**
     * Sanitize the value.
     *
     * @param string $value  The unsanitized value
     * @return string
     */
    protected function sanitizeValue(string $value): string
    {
        return static::collapseWhitespace(static::normalizeWhitespace($value));
    }


    /**
     * Validate the value.
     *
     * @param string $value
     * @throws \SimpleSAML\XML\Exception\SchemaViolationException on failure
     * @return void
     */
    protected function validateValue(string $value): void
    {
        // Note: value must already be sanitized before validating
        Assert::validBoolean($this->sanitizeValue($value), SchemaViolationException::class);
    }


    /**
     * @param boolean $value
     * @return static
     */
    public static function fromBoolean(bool $value): static
    {
        return new static(
            $value === true ? 'true' : 'false',
        );
    }


    /**
     * @return boolean $value
     */
    public function toBoolean(): bool
    {
        return boolval(
            in_array($this->getValue(), ['1', 'true']) ? '1' : '0',
        );
    }
}