AbstractFieldConfigurationReader::configureFields() - 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

configureFields() A

↳ Parent: AbstractFieldConfigurationReader

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	4
c	1
b	0
f	0
dl	0
loc	8
rs	10
cc	1
nc	1
nop	2

<?php

namespace KunicMarko\SonataAnnotationBundle\Reader;

use Doctrine\Common\Annotations\Reader;
use InvalidArgumentException;
use KunicMarko\SonataAnnotationBundle\Annotation\ActionAnnotationInterface;
use KunicMarko\SonataAnnotationBundle\Annotation\AssociationFieldInterface;
use KunicMarko\SonataAnnotationBundle\Annotation\PositionAnnotationInterface;
use ReflectionClass;
use Sonata\AdminBundle\Datagrid\DatagridMapper;
use Sonata\AdminBundle\Datagrid\ListMapper;
use Sonata\AdminBundle\Form\FormMapper;
use Sonata\AdminBundle\Mapper\MapperInterface;
use Sonata\AdminBundle\Show\ShowMapper;

/**
 * Field configuration reader.
 */
class AbstractFieldConfigurationReader extends AbstractReader
{

    /**
     * Associated annotation class.
     *
     * @var string|null
     */
    protected ?string $annotationClass;

    /**
     * @param Reader  $annotationReader Doctrine annotation reader.
     * @param ?string $annotationClass  Associated annotation class.
     */
    public function __construct(
        Reader $annotationReader,
        ?string $annotationClass = null
    ) {
        parent::__construct($annotationReader);
        $this->annotationClass = $annotationClass;
    }

    /**
     * Build list field configurations.
     *
     * @param ReflectionClass $class  Entity class.
     * @param MapperInterface $mapper Admin mapper.
     *
     * @return void
     */
    public function configureFields(
        ReflectionClass $class,
        MapperInterface $mapper
    ): void {
        $this->configureReaderFields(
            $class,
            $mapper,
            $this->annotationClass
        );
    }

    /**
     * Configure fields with positions.
     *
     * @param ReflectionClass $class           Read entity class.
     * @param MapperInterface $mapper          Admin mapper.
     * @param string|null     $annotationClass Filtered annotation class.
     * @param string|null     $action          Current action.
     *
     * @return void
     */
    protected function configureReaderFields(
        ReflectionClass $class,
        MapperInterface $mapper,
        ?string $annotationClass = null,
        ?string $action = null
    ): void {
        $propertiesAndMethods = array_merge(
            $this->getClassPropertiesAnnotations($class, $annotationClass),
            $this->getClassMethodsAnnotations($class, $annotationClass)
        );

        $fields = [];
        $propertiesWithPosition = [];
        $propertiesWithoutPosition = [];

        foreach ($propertiesAndMethods as $name => $annotations) {
            foreach ($annotations as $annotation) {
                if ($annotation instanceof ActionAnnotationInterface
                    && $action !== null
                    && isset($annotation->action)
                    && $annotation->action !== $action
                ) {
                    continue;
                }

                if ($annotation instanceof AssociationFieldInterface) {
                    $name = sprintf('%s.%s', $name, $annotation->field);
                }

                if ($annotation instanceof PositionAnnotationInterface) {
                    if (!isset($annotation->position)) {
                        $propertiesWithoutPosition[] = [
                            'name' => $name,
                            'annotation' => $annotation,
                        ];
                        continue;
                    }

                    if (array_key_exists(
                        $annotation->position,
                        $propertiesWithPosition
                    )) {
                        throw new InvalidArgumentException(
                            sprintf(
                                'Position "%s" is already in use by "%s", try setting a different position for "%s".',
                                $annotation->position,
                                $propertiesWithPosition[$annotation->position]['name'],
                                $name
                            )
                        );
                    }

                    $propertiesWithPosition[$annotation->position] = [
                        'name' => $name,
                        'annotation' => $annotation,
                    ];
                }
            }
        }

        if (!empty($propertiesWithPosition)
            || !empty($propertiesWithoutPosition)
        ) {
            ksort($propertiesWithPosition);

            $fields = array_merge(
                $propertiesWithPosition,
                $propertiesWithoutPosition
            );
        }


        array_walk(
            $fields,
            fn(array $field) => $this->addMapperProperty($mapper, $field)
        );
    }


    /**
     * Add a property to the given mapper.
     *
     * @param MapperInterface $mapper   Admin mapper.
     * @param array           $property Property information.
     *
     * @return void
     */
    private function addMapperProperty(
        MapperInterface $mapper,
        array $property
    ): void {
        if ($mapper instanceof DatagridMapper
            || $mapper instanceof FormMapper
            || $mapper instanceof ListMapper
            || $mapper instanceof ShowMapper
        ) {
            $mapper->add(
                $property['name'],
                ...$property['annotation']->getSettings()
                /** @scrutinizer ignore-type */ ...$property['annotation']->getSettings()
            );
        }
    }

}

neimheadh / SonataAnnotationBundle

Push — develop ( 3d1775...ebd477 )

configureFields() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like