Yiisoft\Validator\RulesDumper

Complexity

Total Complexity

7

Size/Duplication

Total Lines	64
Duplicated Lines	0 %

Test Coverage

Coverage

57.89%

Importance

Changes	1
Bugs	0	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	asArray()	0	17	5
A	withFormatter()	0	5	1

<?php

declare(strict_types=1);

namespace Yiisoft\Validator;

use InvalidArgumentException;
use function get_class;
use function is_array;
use function is_object;

/**
 * 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 ParametrizedRuleInterface
 */
final class RulesDumper
{
    private ?FormatterInterface $formatter;

    public function __construct(?FormatterInterface $formatter)
    {
        $this->formatter = $formatter;
    }

    /**
     * Return all attribute rules as array.
     *
     * For example:
     *
     * ```php
     * [
     *    'amount' => [
     *        [
     *            'number',
     *            'integer' => true,
     *            'max' => 100,
     *            'notANumberMessage' => 'Value must be an integer.',
     *            'tooBigMessage' => 'Value must be no greater than 100.'
     *        ],
     *        ['callback'],
     *    ],
     *    'name' => [
     *        [
     *            'hasLength',
     *            'max' => 20,
     *            'message' => 'Value must contain at most 20 characters.'
     *        ],
     *    ],
     * ]
     * ```
     *
     * @param iterable $rules
     *
     * @return array
     */
    public function asArray(iterable $rules): array
    {
        $rulesOfArray = [];
        foreach ($rules as $attribute => $rulesSet) {
            if (is_array($rulesSet)) {
                $rulesSet = new Rules($rulesSet);
            }
            if (!$rulesSet instanceof Rules) {
                throw new InvalidArgumentException(sprintf(
                    'Value should be an instance of %s or an array of rules, %s given.',
                    Rules::class,
                    is_object($rulesSet) ? get_class($rulesSet) : gettype($rulesSet)
                ));
            }
            $rulesOfArray[$attribute] = $rulesSet->withFormatter($this->formatter)->asArray();
        }
        return $rulesOfArray;
    }

    public function withFormatter(?FormatterInterface $formatter): self
    {
        $new = clone $this;
        $new->formatter = $formatter;
        return $new;
    }
}