Yiisoft\Validator\Rule\HasLength

Complexity

Total Complexity

8

Size/Duplication

Total Lines	71
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

<?php
final class HasLength implements ParametrizedRuleInterface
{
    use HandlerClassNameTrait;
    use RuleNameTrait;

    public function __construct(
        /**
         * @var int|null minimum length. null means no minimum length limit.
         *
         * @see $tooShortMessage for the customized message for a too short string.
         */
        private ?int $min = null,
        /**
         * @var int|null maximum length. null means no maximum length limit.
         *
         * @see $tooLongMessage for the customized message for a too long string.
         */
        private ?int $max = null,
        /**
         * @var string user-defined error message used when the value is not a string.
         */
        private string $message = 'This value must be a string.',
        /**
         * @var string user-defined error message used when the length of the value is smaller than {@see $min}.
         */
        private string $tooShortMessage = 'This value should contain at least {min, number} {min, plural, one{character} other{characters}}.',
        /**
         * @var string user-defined error message used when the length of the value is greater than {@see $max}.
         */
        private string $tooLongMessage = 'This value should contain at most {max, number} {max, plural, one{character} other{characters}}.',
        /**
         * @var string the encoding of the string value to be validated (e.g. 'UTF-8').
         * If this property is not set, application wide encoding will be used.
         */
        private string $encoding = 'UTF-8',
        private bool $skipOnEmpty = false,
        private bool $skipOnError = false,
        private ?Closure $when = null
    ) {
    }

    /**
     * @return int|null
     */
    public function getMin(): ?int
    {
        return $this->min;
    }

    /**
     * @return int|null
     */
    public function getMax(): ?int
    {
        return $this->max;
    }

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

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