Yiisoft\Classifier\AbstractClassifier

Complexity

Total Complexity

12

Size/Duplication

Total Lines	79
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	1	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	getFiles()	0	7	1
A	withFilter()	0	6	1
A	find()	0	7	3
A	skipDeclaration()	0	19	6

<?php

declare(strict_types=1);

namespace Yiisoft\Classifier;

use ReflectionClass;
use Symfony\Component\Finder\Finder;
use Yiisoft\Classifier\Filter\FilterInterface;

/**
 * Base implementation for {@see ClassifierInterface} with common filters.
 */
abstract class AbstractClassifier implements ClassifierInterface
{
    /**
     * @var array<class-string|trait-string, ReflectionClass>

The doc comment array<class-string|trait-string, ReflectionClass> at position 2 could not be parsed: Unknown type name 'class-string' at position 2 in array<class-string|trait-string, ReflectionClass>.

     */
    protected static array $reflectionsCache = [];

    /**
     * @var FilterInterface[]
     */
    private array $filters = [];
    /**
     * @var string[]
     */
    protected array $directories;

    public function __construct(string $directory, string ...$directories)
    {
        $this->directories = [$directory, ...array_values($directories)];

array($directory, array_values($directories)) is of type array<integer,array|string>, but the property $directories was declared to be of type string[]. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

    }

    public function withFilter(FilterInterface ...$filter): static
    {
        $new = clone $this;
        array_push($new->filters, ...array_values($filter));

        return $new;
    }

    /**
     * @return iterable<class-string>
     */
    public function find(): iterable
    {
        foreach ($this->getAvailableDeclarations() as $declaration) {
            if ($this->skipDeclaration($declaration)) {
                continue;
            }
            yield $declaration;
        }
    }

    protected function getFiles(): Finder
    {
        return (new Finder())
            ->in($this->directories)
            ->name('*.php')
            ->sortByName()
            ->files();
    }

    /**
     * @param class-string|trait-string $declaration

The doc comment class-string|trait-string at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string|trait-string.

     */
    private function skipDeclaration(string $declaration): bool
    {
        try {
            $reflectionClass = self::$reflectionsCache[$declaration] ??= new ReflectionClass($declaration);
        } catch (\Throwable) {
            return true;
        }

        if ($reflectionClass->isInternal() || $reflectionClass->isAnonymous()) {
            return true;
        }

        foreach ($this->filters as $filter) {
            if (!$filter->match($reflectionClass)) {
                return true;
            }
        }

        return false;
    }

    /**
     * @return iterable<class-string|trait-string>
     */
    abstract protected function getAvailableDeclarations(): iterable;
}