Yiisoft\Validator\RulesProvider\AttributesRulesProvider

Complexity

Total Complexity

10

Size/Duplication

Total Lines	61
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	5
Bugs	1	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	createAttributes()	0	4	2
A	parseRules()	0	17	5
A	getRules()	0	7	2

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\RulesProvider;

use Generator;
use ReflectionAttribute;
use ReflectionClass;
use ReflectionException;
use ReflectionObject;
use ReflectionProperty;
use Yiisoft\Validator\RuleInterface;
use Yiisoft\Validator\RulesProviderInterface;

use function is_object;

final class AttributesRulesProvider implements RulesProviderInterface
{
    private Generator|iterable|null $rules = null;

    public function __construct(
        /**
         * @param class-string|object $class
         */
        private string|object $source,
        private int $propertyVisibility = ReflectionProperty::IS_PRIVATE | ReflectionProperty::IS_PROTECTED | ReflectionProperty::IS_PUBLIC
    ) {
    }

    /**
     * @throws ReflectionException
     *
     * @return iterable
     */
    public function getRules(): iterable
    {
        if ($this->rules === null) {
            $this->rules = $this->parseRules();
        }

        yield from $this->rules;
    }

    /**
     * @throws ReflectionException
     *
     * @return Generator
     */
    private function parseRules(): iterable
    {
        $reflection = is_object($this->source)
            ? new ReflectionObject($this->source)
            : new ReflectionClass($this->source);

        $reflectionProperties = $reflection->getProperties($this->propertyVisibility);
        if ($reflectionProperties === []) {
            return [];
        }
        foreach ($reflectionProperties as $property) {
            $attributes = $property->getAttributes(RuleInterface::class, ReflectionAttribute::IS_INSTANCEOF);
            if ($attributes === []) {
                continue;
            }

            yield $property->getName() => $this->createAttributes($attributes);
        }
    }

    /**
     * @param array<array-key, ReflectionAttribute<RuleInterface>> $attributes

The doc comment array<array-key, ReflectionAttribute<RuleInterface>> at position 2 could not be parsed: Unknown type name 'array-key' at position 2 in array<array-key, ReflectionAttribute<RuleInterface>>.

     *
     * @return iterable
     */
    private function createAttributes(array $attributes): iterable
    {
        foreach ($attributes as $attribute) {
            yield $attribute->newInstance();
        }
    }
}