Yiisoft\Validator\Rule\HasLength

Complexity

Total Complexity

6

Size/Duplication

Total Lines	105
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getName()	0	3	1
A	getEncoding()	0	3	1
A	__construct()	0	59	1
A	getOptions()	0	9	1
A	getHandlerClassName()	0	3	1
A	getIncorrectInputMessage()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use Attribute;
use Closure;
use Yiisoft\Validator\LimitInterface;
use Yiisoft\Validator\Rule\Trait\LimitTrait;
use Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait;
use Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait;
use Yiisoft\Validator\Rule\Trait\WhenTrait;
use Yiisoft\Validator\SerializableRuleInterface;
use Yiisoft\Validator\SkipOnEmptyInterface;
use Yiisoft\Validator\SkipOnErrorInterface;
use Yiisoft\Validator\ValidationContext;
use Yiisoft\Validator\WhenInterface;

/**
 * Validates that the value is of certain length.
 *
 * Note, this rule should only be used with strings.
 */
#[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
final class HasLength implements
    SerializableRuleInterface,
    SkipOnErrorInterface,
    WhenInterface,
    SkipOnEmptyInterface,
    LimitInterface
{
    use LimitTrait;
    use SkipOnEmptyTrait;
    use SkipOnErrorTrait;
    use WhenTrait;

    public function __construct(
        /**
         * @var int|null minimum length. null means no minimum length limit. Can't be combined with
         * {@see $exactly}.
         *
         * @see $lessThanMinMessage for the customized message for a too short string.
         */
        ?int $min = null,
        /**
         * @var int|null maximum length. null means no maximum length limit. Can't be combined with
         * {@see $exactly}.
         *
         * @see $greaterThanMaxMessage for the customized message for a too long string.
         */
        ?int $max = null,
        /**
         * @var int|null exact length. `null` means no strict comparison. Mutually exclusive with {@see $min} and
         * {@see $max}.
         */
        ?int $exactly = null,
        /**
         * @var string user-defined error message used when the value is not a string.
         */
        private string $incorrectInputMessage = 'This value must be a string.',
        /**
         * @var string user-defined error message used when the length of the value is smaller than {@see $min}.
         */
        string $lessThanMinMessage = 'This value must 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}.
         */
        string $greaterThanMaxMessage = 'This value must contain at most {max, number} {max, plural, one{character} ' .
        'other{characters}}.',
        string $notExactlyMessage = 'This value must contain exactly {exactly, number} {exactly, 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',

        /**
         * @var bool|callable|null
         */
        private $skipOnEmpty = null,
        private bool $skipOnError = false,
        /**
         * @var Closure(mixed, ValidationContext):bool|null
         */
        private ?Closure $when = null
    ) {
        $this->initLimitProperties(
            $min,
            $max,
            $exactly,
            $lessThanMinMessage,
            $greaterThanMaxMessage,
            $notExactlyMessage
        );
    }

    public function getName(): string
    {
        return 'hasLength';
    }

    public function getIncorrectInputMessage(): string
    {
        return $this->incorrectInputMessage;
    }

    public function getEncoding(): string
    {
        return $this->encoding;
    }

    public function getOptions(): array
    {
        return array_merge($this->getLimitOptions(), [
            'incorrectInputMessage' => [
                'message' => $this->incorrectInputMessage,
            ],
            'encoding' => $this->encoding,
            'skipOnEmpty' => $this->getSkipOnEmptyOption(),
            'skipOnError' => $this->skipOnError,
        ]);
    }

    public function getHandlerClassName(): string
    {
        return HasLengthHandler::class;
    }
}