Yiisoft\Validator\Rule\Boolean

Complexity

Total Complexity

14

Size/Duplication

Total Lines	106
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	22	1
A	trueValue()	0	6	1
A	getFormattedMessage()	0	5	3
A	falseValue()	0	6	1
A	validateValue()	0	18	5
A	getOptions()	0	7	1
A	strict()	0	6	1
A	message()	0	6	1

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use Attribute;
use Yiisoft\Validator\FormatterInterface;
use Yiisoft\Validator\Result;
use Yiisoft\Validator\Rule;
use Yiisoft\Validator\ValidationContext;

/**
 * Checks if the value is a boolean value or a value corresponding to it.
 */
#[Attribute(Attribute::TARGET_PROPERTY)]
final class Boolean extends Rule
{
    public function __construct(
        /**
         * @var mixed the value representing true status.
         */
        private mixed $trueValue = '1',
        /**
         * @var mixed the value representing false status.
         */
        private mixed $falseValue = '0',
        /**
         * @var bool whether the comparison to {@see $trueValue} and {@see $falseValue} is strict.
         * When this is `true`, the value and type must both match those of {@see $trueValue} or
         * {@see $falseValue}. Defaults to `false`, meaning only the value needs to be matched.
         */
        private bool $strict = false,
        private string $message = 'The value must be either "{true}" or "{false}".',
        ?FormatterInterface $formatter = null,
        bool $skipOnEmpty = false,
        bool $skipOnError = false,
        $when = null
    ) {
        parent::__construct(formatter: $formatter, skipOnEmpty: $skipOnEmpty, skipOnError: $skipOnError, when: $when);
    }

    /**
     * @see $trueValue
     */
    public function trueValue(mixed $value): self
    {
        $new = clone $this;
        $new->trueValue = $value;

        return $new;
    }

    /**
     * @see $falseValue
     */
    public function falseValue(mixed $value): self
    {
        $new = clone $this;
        $new->falseValue = $value;

        return $new;
    }

    /**
     * @see $strict
     */
    public function strict(bool $value): self
    {
        $new = clone $this;
        $new->strict = $value;

        return $new;
    }

    /**
     * @see $message
     */
    public function message(string $value): self
    {
        $new = clone $this;
        $new->message = $value;

        return $new;
    }

    protected function validateValue($value, ?ValidationContext $context = null): Result
    {
        if ($this->strict) {
            $valid = $value === $this->trueValue || $value === $this->falseValue;
        } else {
            $valid = $value == $this->trueValue || $value == $this->falseValue;
        }

        $result = new Result();

        if ($valid) {
            return $result;
        }

        $message = $this->getFormattedMessage();
        $result->addError($message);

        return $result;
    }

    private function getFormattedMessage(): string
    {
        return $this->formatMessage($this->message, [
            'true' => $this->trueValue === true ? 'true' : $this->trueValue,
            'false' => $this->falseValue === false ? 'false' : $this->falseValue,
        ]);
    }

    public function getOptions(): array
    {
        return array_merge(parent::getOptions(), [
            'trueValue' => $this->trueValue,
            'falseValue' => $this->falseValue,
            'strict' => $this->strict,
            'message' => $this->getFormattedMessage(),
        ]);
    }
}