Yiisoft\Validator\Rule\Boolean

Complexity

Total Complexity

10

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

<?php
/**
 * Checks if the value is a boolean value or a value corresponding to it.
 */
#[Attribute(Attribute::TARGET_PROPERTY)]
final class Boolean implements ParametrizedRuleInterface, PreValidatableRuleInterface
{
    use HandlerClassNameTrait;
    use PreValidatableTrait;
    use RuleNameTrait;

    public function __construct(
        /**
         * @var mixed the value representing true status. Defaults to '1'.
         */
        private $trueValue = '1',
        /**
         * @var mixed the value representing false status. Defaults to '0'.
         */
        private $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}".',
        private bool $skipOnEmpty = false,
        private bool $skipOnError = false,
        private ?Closure $when = null,
    ) {
    }

    /**
     * @return mixed
     */
    public function getTrueValue(): mixed
    {
        return $this->trueValue;
    }

    /**
     * @return mixed
     */
    public function getFalseValue(): mixed
    {
        return $this->falseValue;
    }

    /**
     * @return bool
     */
    public function isStrict(): bool
    {
        return $this->strict;
    }

    /**
     * @return string
     */
    public function getMessage(): string
    {
        return $this->message;
    }