GraphQL\Doctrine\Attribute\Reader\Reader

Complexity

Total Complexity

11

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Test Coverage

Coverage

92.59%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	onlyOne()	0	7	3
A	getRecursiveClassAttributes()	0	19	4
A	getAttributeInstances()	0	17	3
A	getAttribute()	0	5	1

<?php

declare(strict_types=1);

namespace GraphQL\Doctrine\Attribute\Reader;

use GraphQL\Doctrine\Attribute\ApiAttribute;
use GraphQL\Doctrine\Exception;
use ReflectionClass;
use ReflectionMethod;
use ReflectionParameter;
use ReflectionProperty;

/**
 * API attribute reader.
 */
final class Reader
{
    /**
     * Return an array of all attributes found in the class hierarchy, including its traits, indexed by the class name.
     *
     * @template T of ApiAttribute
     *
     * @param class-string<T> $attributeName
     *
     * @return array<class-string, T[]> attributes indexed by the class name where they were found

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

     */
    public function getRecursiveClassAttributes(ReflectionClass $class, string $attributeName): array
    {
        $result = [];

        $attributes = $this->getAttributeInstances($class, $attributeName);
        if ($attributes) {
            $result[$class->getName()] = $attributes;
        }

        foreach ($class->getTraits() as $trait) {
            $result = array_merge($result, self::getRecursiveClassAttributes($trait, $attributeName));

The method GraphQL\Doctrine\Attribute\Reader\Reader::getRecursiveClassAttributes() is not static, but was called statically.

        }

        $parent = $class->getParentClass();
        if ($parent) {
            $result = array_merge($result, self::getRecursiveClassAttributes($parent, $attributeName));
        }

        return $result;
    }

    /**
     * @template T of ApiAttribute
     *
     * @param class-string<T> $attributeName
     *
     * @return null|T
     */
    public function getAttribute(ReflectionClass|ReflectionProperty|ReflectionMethod|ReflectionParameter $element, string $attributeName): ?ApiAttribute
    {
        $attributes = $this->getAttributeInstances($element, $attributeName);

        return $this->onlyOne($attributes);

The expression return $this->onlyOne($attributes) also could return the type GraphQL\Doctrine\Attribute\ApiAttribute which is incompatible with the documented return type GraphQL\Doctrine\Attribute\Reader\T|null.

    }

    /**
     * @template T of ApiAttribute
     *
     * @param T[] $attributes
     *
     * @return null|T

The type GraphQL\Doctrine\Attribute\Reader\T was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    private function onlyOne(array $attributes): ?ApiAttribute
    {
        if (count($attributes) > 1) {
            throw new Exception('Expected to find single attribute, but found many');
        }

        return reset($attributes) ?: null;
    }

    /**
     * @template T of ApiAttribute
     *
     * @param class-string<T> $attributeName
     *
     * @return T[]
     */
    private function getAttributeInstances(ReflectionClass|ReflectionMethod|ReflectionParameter|ReflectionProperty $element, string $attributeName): array
    {
        if (!is_subclass_of($attributeName, ApiAttribute::class)) {
            throw new Exception('This should not be used for attribute than are not ours');
        }

        $attributes = $element->getAttributes($attributeName);
        $instances = [];

        foreach ($attributes as $attribute) {
            $instance = $attribute->newInstance();
            assert($instance instanceof ApiAttribute);

            $instances[] = $instance;
        }

        return $instances;

The expression return $instances returns an array which contains values of type GraphQL\Doctrine\Attribute\ApiAttribute which are incompatible with the documented value type GraphQL\Doctrine\Attribute\Reader\T.

    }
}