0 follower

Final Class Yiisoft\Validator\Helper\RulesDumper

InheritanceYiisoft\Validator\Helper\RulesDumper

RulesDumper allows to get an array of rule names and corresponding settings from a set of rules.

The array is usually passed to the client to use it in client-side validation.

See also:

Public Methods

Hide inherited methods

Method Description Defined By
asArray() Return rules as array. Yiisoft\Validator\Helper\RulesDumper

Method Details

Hide inherited methods

asArray() public static method

Return rules as array.

For example:

[
    'name' => [
        [
            'length',
            'min' => 4,
            'max' => 10,
            'exactly' => null,
            'lessThanMinMessage' => [
                'template' => 'This value must contain at least {min, number} {min, plural, one{character} other{characters}}.',
                'parameters' => ['min' => 4],
            ],
            'greaterThanMaxMessage' => [
                'template' => 'This value must contain at most {max, number} {max, plural, one{character} other{characters}}.',
                'parameters' => ['max' => 10],
            ],
            'notExactlyMessage' => [
                'template' => 'This value must contain exactly {exactly, number} {exactly, plural, one{character} other{characters}}.',
                'parameters' => ['exactly' => null],
            ],
                'incorrectInputMessage' => [
                'template' => 'The value must be a string.',
                'parameters' => [],
            ],
            'encoding' => 'UTF-8',
            'skipOnEmpty' => false,
            'skipOnError' => false,
        ],
        [
            'callback',
        ],
    ],
    // ...
],
public static array asArray ( iterable $rules )
$rules iterable

Arrays of rule objects indexed by properties.

return array

Array of rule names and corresponding settings indexed by properties.

                public static function asArray(iterable $rules): array
{
    return self::fetchOptions($rules);
}