AbstractReader::getClassAnnotations() - Code Metrics - Inspection of "[Fix] Sanitize Reader code" - neimheadh/SonataAnnotationBundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — develop ( 3d1775...ebd477 )

by Mathieu
created 2023-02-17 10:25 UTC
AbstractReader::getClassAnnotations() A

↳ Parent: AbstractReader
Complexity

Conditions	3
Paths	2
Size

Total Lines	25
Code Lines	15
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
eloc	15
c	1
b	0
f	0
dl	0
loc	25
rs	9.7666
cc	3
nc	2
nop	2
<?php

namespace KunicMarko\SonataAnnotationBundle\Reader;

use Doctrine\Common\Annotations\Reader;
use KunicMarko\SonataAnnotationBundle\Annotation\AnnotationInterface;
use KunicMarko\SonataAnnotationBundle\Annotation\AssociationFieldInterface;
use KunicMarko\SonataAnnotationBundle\Annotation\RouteAnnotationInterface;
use KunicMarko\SonataAnnotationBundle\Exception\MissingAnnotationArgumentException;
use ReflectionClass;
use ReflectionMethod;
use ReflectionProperty;

/**
 * Annotation reader.
 */
abstract class AbstractReader
{

    /**
     * Doctrine annotation reader.
     *
     * @var Reader
     */
    protected Reader $annotationReader;

    /**
     * @param Reader $annotationReader Doctrine annotation reader.
     */
    public function __construct(Reader $annotationReader)
    {
        $this->annotationReader = $annotationReader;
    }

    /**
     * Check the given annotation is well-defined.
     *
     * @param AnnotationInterface $annotation The annotation.
     * @param ReflectionClass     $class      Class having the annotation.
     *
     * @return void
     */
    protected function checkAnnotationIntegrity(
        AnnotationInterface $annotation,
        ReflectionClass $class
    ): void {
        if ($annotation instanceof AssociationFieldInterface
            && !isset($annotation->field)) {
            throw new MissingAnnotationArgumentException(
                $annotation,
                'field',
            );
        }

        if ($annotation instanceof RouteAnnotationInterface
            && !isset($annotation->name)) {
            throw new MissingAnnotationArgumentException(
                $annotation,
                'name',
                $class
            );
        }
    }

    /**
     * Get a specific annotation for the given entity class.
     *
     * @param ReflectionClass $class      Entity class.
     * @param string          $annotation Annotation class.
     *
     * @return object|AnnotationInterface|null
     */
    protected function getClassAnnotation(
        ReflectionClass $class,
        string $annotation
    ): ?object {
        return $this->annotationReader->getClassAnnotation($class, $annotation);
    }

    /**
     * Get the list of annotations for a given entity class.
     *
     * @param ReflectionClass $class              Entity class.
     * @param ?string         $annotationClass    If given, filter annotation
     *                                            having the specified class.
     *
     * @return array<object|AnnotationInterface>
     */
    protected function getClassAnnotations(
        ReflectionClass $class,
        ?string $annotationClass = null
    ): array {
        $annotations = $annotationClass === null
            ? $this->annotationReader->getClassAnnotations($class)
            : array_filter(
                $this->annotationReader->getClassAnnotations($class),
                fn(
                    object $annotation
                ) => $annotation instanceof $annotationClass
            );

        array_walk(
            $annotations,
            function(object $annotation) use ($class) {

                $annotation instanceof AnnotationInterface
                && $this->checkAnnotationIntegrity(
                    $annotation,
                    $class
                );
            }
        );

        return $annotations;
    }

    /**
     * Get class methods annotations.
     *
     * @param ReflectionClass $class           Entity class.
     * @param ?string         $annotationClass Annotation class.
     *
     * @return array<string, object|AnnotationInterface[]>
     */
    protected function getClassMethodsAnnotations(
        ReflectionClass $class,
        ?string $annotationClass = null
    ): array {
        $annotations = [];

        foreach ($class->getMethods() as $method) {
            $annotations[$method->getName()] = $this->getMethodAnnotations(
                $method,
                $annotationClass
                /** @scrutinizer ignore-type */ $annotationClass
            );
        }

        return $annotations;
    }

    /**
     * Get class properties annotations.
     *
     * @param ReflectionClass $class           Entity class.
     * @param ?string         $annotationClass Annotation class.
     *
     * @return array<string, object|AnnotationInterface[]>
     */
    protected function getClassPropertiesAnnotations(
        ReflectionClass $class,
        ?string $annotationClass = null
    ): array {
        $annotations = [];

        foreach ($class->getProperties() as $property) {
            $annotations[$property->getName()] = $this->getPropertyAnnotations(
                $property,
                $annotationClass
            );
        }

        return $annotations;
    }

    /**
     * Get a method annotation.
     *
     * @param ReflectionMethod $method     Method.
     * @param string           $annotation Annotation class.
     *
     * @return object|AnnotationInterface|null
     */
    protected function getMethodAnnotation(
        ReflectionMethod $method,
        string $annotation
    ): ?object {
        return $this->annotationReader->getMethodAnnotation(
            $method,
            $annotation
        );
    }

    /**
     * Get the list of annotations for a given method.
     *
     * @param ReflectionMethod $method          Method.
     * @param string           $annotationClass Filter annotation having the
     *                                          specified class.
     *
     * @return array<object|AnnotationInterface>
     */
    protected function getMethodAnnotations(
        ReflectionMethod $method,
        string $annotationClass
    ): array {
        $annotations = array_filter(
            $this->annotationReader->getMethodAnnotations($method),
            fn(
                object $annotation
            ) => $annotation instanceof $annotationClass
        );

        array_walk(
            $annotations,
            function(object $annotation) use ($method) {

                $annotation instanceof AnnotationInterface
                && $this->checkAnnotationIntegrity(
                    $annotation,
                    $method->getDeclaringClass()
                );
            }
        );

        return $annotations;
    }

    /**
     * Get the list of annotations for a given property.
     *
     * @param ReflectionProperty $property        Property.
     * @param ?string            $annotationClass If given, filter annotation
     *                                            having the specified class.
     *
     * @return array<object|AnnotationInterface>
     */
    protected function getPropertyAnnotations(
        ReflectionProperty $property,
        ?string $annotationClass = null
    ): array {
        $annotations = $annotationClass === null
            ? $this->annotationReader->getPropertyAnnotations($property)
            : array_filter(
                $this->annotationReader->getPropertyAnnotations($property),
                fn(
                    object $annotation
                ) => $annotation instanceof $annotationClass
            );

        array_walk(
            $annotations,
            function(object $annotation) use ($property) {

                $annotation instanceof AnnotationInterface
                && $this->checkAnnotationIntegrity(
                    $annotation,
                    $property->getDeclaringClass()
                );
            }
        );

        return $annotations;
    }

}
neimheadh / SonataAnnotationBundle

Push — develop ( 3d1775...ebd477 )

AbstractReader::getClassAnnotations() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
