Final Class Yiisoft\Validator\Rule\Count

All Classes | Methods

Inheritance	Yiisoft\Validator\Rule\Count
Implements	Yiisoft\Validator\CountableLimitInterface, Yiisoft\Validator\DumpedRuleInterface, Yiisoft\Validator\SkipOnEmptyInterface, Yiisoft\Validator\SkipOnErrorInterface, Yiisoft\Validator\WhenInterface
Uses Traits	Yiisoft\Validator\Rule\Trait\CountableLimitTrait, Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait, Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait, Yiisoft\Validator\Rule\Trait\WhenTrait

Defines validation options to check that the value contains certain number of items.

Can be applied to arrays or classes implementing {@see \Countable} interface.

Public Methods

Hide inherited methods

Method	Description	Defined By
__construct()		Yiisoft\Validator\Rule\Count
getExactly()	A getter for {@see $exactly} property.	Yiisoft\Validator\Rule\Trait\CountableLimitTrait
getGreaterThanMaxMessage()	A getter for {@see $greaterThanMaxMessage} property.	Yiisoft\Validator\Rule\Trait\CountableLimitTrait
getHandler()		Yiisoft\Validator\Rule\Count
getIncorrectInputMessage()	Get error message used when the value is neither an array nor an object implementing {@see Countable} interface.	Yiisoft\Validator\Rule\Count
getLessThanMinMessage()	A getter for {@see $lessThanMinMessage} property.	Yiisoft\Validator\Rule\Trait\CountableLimitTrait
getMax()	A getter for {@see $max property}.	Yiisoft\Validator\Rule\Trait\CountableLimitTrait
getMin()	A getter for {@see $min} property.	Yiisoft\Validator\Rule\Trait\CountableLimitTrait
getName()		Yiisoft\Validator\Rule\Count
getNotExactlyMessage()	A getter for {@see $notExactlyMessage} property.	Yiisoft\Validator\Rule\Trait\CountableLimitTrait
getOptions()		Yiisoft\Validator\Rule\Count
getSkipOnEmpty()	A getter for `$skipOnEmpty` property.	Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait
getWhen()	A getter for `$when` property.	Yiisoft\Validator\Rule\Trait\WhenTrait
shouldSkipOnError()	A getter for `$skipOnError` property.	Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait
skipOnEmpty()	An immutable setter to change `$skipOnEmpty` property.	Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait
skipOnError()	An immutable setter to change `$skipOnError` property.	Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait
when()	An immutable setter to change `$when` property.	Yiisoft\Validator\Rule\Trait\WhenTrait

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( integer\|null $exactly = null, integer\|null $min = null, integer\|null $max = null, string $incorrectInputMessage = '{Property} must be an array or implement \\Countable interface. ' . '{type} given.', string $lessThanMinMessage = '{Property} must contain at least {min, number} {min, plural, one{item} ' . 'other{items}}.', string $greaterThanMaxMessage = '{Property} must contain at most {max, number} {max, plural, one{item} ' . 'other{items}}.', string $notExactlyMessage = '{Property} must contain exactly {exactly, number} {exactly, plural, one{item} ' . 'other{items}}.', boolean\|callable\|null $skipOnEmpty = null, boolean $skipOnError = false, Closure\|null $when = null )
$exactly	integer\|null	Exact number of items. `null` means no strict comparison. Mutually exclusive with {@see $min} and {@see $max}.
$min	integer\|null	Minimum number of items. null means no minimum number limit. Can't be combined with {@see $exactly}. See {@see $lessThanMinMessage} for the customized message for a value with too few items.
$max	integer\|null	Maximum number of items. null means no maximum number limit. Can't be combined with {@see $exactly}. See {@see $greaterThanMaxMessage} for the customized message for a value with too many items.
$incorrectInputMessage	string	Error message used when the value is neither an array nor an object implementing {@see \Countable} interface. You may use the following placeholders in the message: `{property}`: the translated label of the property being validated. `{type}`: the type of the value being validated.
$lessThanMinMessage	string	Error message used when the number of items is smaller than {@see $min}. You may use the following placeholders in the message: `{property}`: the translated label of the property being validated. `{min}`: minimum number of items required. `{number}`: actual number of items.
$greaterThanMaxMessage	string	Error message used when the number of items is greater than {@see $max}. You may use the following placeholders in the message: `{property}`: the translated label of the property being validated. `{max}`: maximum number of items required. `{number}`: actual number of items.
$notExactlyMessage	string	Error message used when the number of items does not equal {@see $exactly}. You may use the following placeholders in the message: `{property}`: the translated label of the property being validated. `{exactly}`: exact number of items required. `{number}`: actual number of items.
$skipOnEmpty	boolean\|callable\|null	Whether to skip this rule if the value validated is empty. See {@see \Yiisoft\Validator\SkipOnEmptyInterface}.
$skipOnError	boolean	Whether to skip this rule if any of the previous rules gave an error. See {@see \Yiisoft\Validator\SkipOnErrorInterface}.
$when	Closure\|null	A callable to define a condition for applying the rule. See {@see \Yiisoft\Validator\WhenInterface}.

Source code

                public function __construct(
    ?int $exactly = null,
    ?int $min = null,
    ?int $max = null,
    private string $incorrectInputMessage = '{Property} must be an array or implement \Countable interface. '
    . '{type} given.',
    string $lessThanMinMessage = '{Property} must contain at least {min, number} {min, plural, one{item} '
    . 'other{items}}.',
    string $greaterThanMaxMessage = '{Property} must contain at most {max, number} {max, plural, one{item} '
    . 'other{items}}.',
    string $notExactlyMessage = '{Property} must contain exactly {exactly, number} {exactly, plural, one{item} '
    . 'other{items}}.',
    bool|callable|null $skipOnEmpty = null,
    private bool $skipOnError = false,
    private ?Closure $when = null,
) {
    $this->initCountableLimitProperties(
        $min,
        $max,
        $exactly,
        $lessThanMinMessage,
        $greaterThanMaxMessage,
        $notExactlyMessage,
    );
    $this->skipOnEmpty = $skipOnEmpty;
}

getExactly() public method

Defined in: Yiisoft\Validator\Rule\Trait\CountableLimitTrait::getExactly()

A getter for {@see $exactly} property.

public integer\|null getExactly ( )
return	integer\|null	A number representing "exactly" value. `null` means no strict comparison so lower / upper limits / both must be set.

Source code

                public function getExactly(): ?int
{
    return $this->exactly;
}

getGreaterThanMaxMessage() public method

Defined in: Yiisoft\Validator\Rule\Trait\CountableLimitTrait::getGreaterThanMaxMessage()

A getter for {@see $greaterThanMaxMessage} property.

public string getGreaterThanMaxMessage ( )
return	string	Validation error message.

Source code

                public function getGreaterThanMaxMessage(): string
{
    return $this->greaterThanMaxMessage;
}

getHandler() public method

public string getHandler ( )

Source code

                public function getHandler(): string
{
    return CountHandler::class;
}

getIncorrectInputMessage() public method

Get error message used when the value is neither an array nor an object implementing {@see Countable} interface.

public string getIncorrectInputMessage ( )
return	string	Error message.

Source code

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

getLessThanMinMessage() public method

Defined in: Yiisoft\Validator\Rule\Trait\CountableLimitTrait::getLessThanMinMessage()

A getter for {@see $lessThanMinMessage} property.

public string getLessThanMinMessage ( )
return	string	Validation error message.

Source code

                public function getLessThanMinMessage(): string
{
    return $this->lessThanMinMessage;
}

getMax() public method

Defined in: Yiisoft\Validator\Rule\Trait\CountableLimitTrait::getMax()

A getter for {@see $max property}.

public integer\|null getMax ( )
return	integer\|null	A number representing maximum boundary. `null` means no upper bound.

Source code

                public function getMax(): ?int
{
    return $this->max;
}

getMin() public method

Defined in: Yiisoft\Validator\Rule\Trait\CountableLimitTrait::getMin()

A getter for {@see $min} property.

public integer\|null getMin ( )
return	integer\|null	A number representing minimum boundary. `null` means no lower bound.

Source code

                public function getMin(): ?int
{
    return $this->min;
}

getName() public method

public string getName ( )

Source code

                public function getName(): string
{
    return self::class;
}

getNotExactlyMessage() public method

Defined in: Yiisoft\Validator\Rule\Trait\CountableLimitTrait::getNotExactlyMessage()

A getter for {@see $notExactlyMessage} property.

public string getNotExactlyMessage ( )
return	string	Validation error message.

Source code

                public function getNotExactlyMessage(): string
{
    return $this->notExactlyMessage;
}

getOptions() public method

public array getOptions ( )

Source code

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

getSkipOnEmpty() public method

Defined in: Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait::getSkipOnEmpty()

A getter for $skipOnEmpty property.

public boolean\|callable\|null getSkipOnEmpty ( )
return	boolean\|callable\|null	A current raw (non-normalized) value.

Source code

                public function getSkipOnEmpty(): bool|callable|null
{
    return $this->skipOnEmpty;
}

getWhen() public method

Defined in: Yiisoft\Validator\Rule\Trait\WhenTrait::getWhen()

A getter for $when property.

public Closure\|null getWhen ( )
return	Closure\|null	Current value: `null` - always apply the validation. `callable` - apply the validation depending on a return value: `true` - apply, `false` - do not apply.

Source code

                public function getWhen(): ?Closure
{
    return $this->when;
}

shouldSkipOnError() public method

Defined in: Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait::shouldSkipOnError()

A getter for $skipOnError property.

public boolean shouldSkipOnError ( )
return	boolean	Current value. `true` means to skip the current rule when the previous one errored and `false` - do not skip.

Source code

                public function shouldSkipOnError(): bool
{
    return $this->skipOnError;
}

skipOnEmpty() public method

Defined in: Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait::skipOnEmpty()

An immutable setter to change $skipOnEmpty property.

public $this skipOnEmpty ( boolean\|callable\|null $value )
$value	boolean\|callable\|null	A new value.
return	$this	The new instance with a changed value.

Source code

                public function skipOnEmpty(bool|callable|null $value): static
{
    $new = clone $this;
    $new->skipOnEmpty = $value;
    return $new;
}

skipOnError() public method

Defined in: Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait::skipOnError()

An immutable setter to change $skipOnError property.

public $this skipOnError ( boolean $value )
$value	boolean	A new value. `true` means to skip the current rule when the previous one errored and `false` - do not skip.
return	$this	The new instance with a changed value.

Source code

                public function skipOnError(bool $value): static
{
    $new = clone $this;
    $new->skipOnError = $value;
    return $new;
}

when() public method

Defined in: Yiisoft\Validator\Rule\Trait\WhenTrait::when()

An immutable setter to change $when property.

public $this when ( Closure\|null $value )
$value	Closure\|null	A new value: `null` - always apply the validation. `callable` - apply the validation depending on a return value: `true` - apply, `false` - do not apply.
return	$this	The new instance with a changed value.

Source code

                public function when(?Closure $value): static
{
    $new = clone $this;
    $new->when = $value;
    return $new;
}

Final Class Yiisoft\Validator\Rule\Count

Public Methods

Method Details

User Contributed Notes

Leave a comment