Yiisoft\Validator\Rule\AtLeast

Complexity

Total Complexity

7

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	validateValue()	0	18	4
A	__construct()	0	20	1
A	getFormattedMessage()	0	3	1
A	getOptions()	0	6	1

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use Attribute;
use Yiisoft\Validator\FormatterInterface;
use Yiisoft\Validator\Result;
use Yiisoft\Validator\Rule;
use Yiisoft\Validator\ValidationContext;

/**
 * Checks if at least {@see AtLeast::$min} of many object attributes are filled.
 */
#[Attribute(Attribute::TARGET_PROPERTY)]
final class AtLeast extends Rule
{
    public function __construct(
        /**
         * @var string[] The list of required attributes that will be checked.
         */
        private array $attributes,
        /**
         * @var int The minimum required quantity of filled attributes to pass the validation.
         * Defaults to 1.
         */
        private int $min = 1,
        /**
         * @var string Message to display in case of error.
         */
        private string $message = 'The model is not valid. Must have at least "{min}" filled attributes.',
        ?FormatterInterface $formatter = null,
        bool $skipOnEmpty = false,
        bool $skipOnError = false,
        $when = null
    ) {
        parent::__construct(formatter: $formatter, skipOnEmpty: $skipOnEmpty, skipOnError: $skipOnError, when: $when);
    }

    protected function validateValue($value, ?ValidationContext $context = null): Result
    {
        $filledCount = 0;

        foreach ($this->attributes as $attribute) {
            if (!$this->isEmpty($value->{$attribute})) {
                $filledCount++;
            }
        }

        $result = new Result();

        if ($filledCount < $this->min) {
            $message = $this->getFormattedMessage();
            $result->addError($message);
        }

        return $result;
    }

    private function getFormattedMessage(): string
    {
        return $this->formatMessage($this->message, ['min' => $this->min]);
    }

    public function getOptions(): array
    {
        return array_merge(parent::getOptions(), [
            'attributes' => $this->attributes,
            'min' => $this->min,
            'message' => $this->getFormattedMessage(),
        ]);
    }
}