Silverback\ApiComponentsBundle\AnnotationReader\UploadableAnnotationReader

Complexity

Total Complexity

23

Size/Duplication

Total Lines	84
Duplicated Lines	0 %

Test Coverage

Coverage

73.68%

Importance

Changes	2
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getConfiguration()	0	8	2
A	getPropertyConfiguration()	0	13	5
A	isConfigured()	0	7	5
B	getConfiguredProperties()	0	18	8
A	isFieldConfigured()	0	9	2

<?php

/*
 * This file is part of the Silverback API Components Bundle Project
 *
 * (c) Daniel West <daniel@silverback.is>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Silverback\ApiComponentsBundle\AnnotationReader;

use Doctrine\Common\Annotations\Reader;
use Doctrine\Persistence\ManagerRegistry;
use Silverback\ApiComponentsBundle\Annotation\Uploadable;
use Silverback\ApiComponentsBundle\Annotation\UploadableField;
use Silverback\ApiComponentsBundle\Entity\Utility\ImagineFiltersInterface;
use Silverback\ApiComponentsBundle\Exception\BadMethodCallException;
use Silverback\ApiComponentsBundle\Exception\InvalidArgumentException;
use Silverback\ApiComponentsBundle\Exception\UnsupportedAnnotationException;

/**
 * @author Vincent Chalamon <vincent@les-tilleuls.coop>
 */
final class UploadableAnnotationReader extends AnnotationReader implements UploadableAnnotationReaderInterface
{
    private bool $imagineBundleEnabled;

    public function __construct(Reader $reader, ManagerRegistry $managerRegistry, bool $imagineBundleEnabled)
    {
        $this->imagineBundleEnabled = $imagineBundleEnabled;
        parent::__construct($reader, $managerRegistry);
    }

    /**
     * @param object|string $class
     */
    public function isConfigured($class): bool
    {
        $isConfigured = parent::isConfigured($class);
        if (!$isConfigured || $this->imagineBundleEnabled || !is_a($class, ImagineFiltersInterface::class)) {
            return $isConfigured;
        }
        throw new BadMethodCallException(sprintf('LiipImagineBundle is not enabled/installed so you should not configure Imagine filters on %s', \is_string($class) ? $class : \get_class($class)));

The condition is_string($class) is always false.

    }

    /**
     * @param object|string $class
     */
    public function getConfiguration($class): Uploadable
    {
        $uploadable = $this->getClassAnnotationConfiguration($class, Uploadable::class);
        if (!$uploadable instanceof Uploadable) {
            throw new \LogicException(sprintf('getClassAnnotationConfiguration should return the type %s', Uploadable::class));
        }

        return $uploadable;
    }

    public function isFieldConfigured(\ReflectionProperty $property): bool
    {
        try {
            $this->getPropertyConfiguration($property);
        } catch (InvalidArgumentException $e) {
            return false;
        }

        return true;
    }

    public function getPropertyConfiguration(\ReflectionProperty $property): UploadableField
    {
        /** @var UploadableField|null $annotation */
        $annotation = $this->reader->getPropertyAnnotation($property, UploadableField::class);
        if (!$annotation instanceof UploadableField) {
            throw new InvalidArgumentException(sprintf('%s::%s does not have %s annotation', $property->getDeclaringClass()->getName(), $property->getName(), UploadableField::class));
        }

        if (!$this->imagineBundleEnabled && null !== $annotation->imagineFilters && \count($annotation->imagineFilters)) {
            throw new BadMethodCallException(sprintf('LiipImagineBundle is not enabled/installed so you should not configure Imagine filters on %s::$%s', $property->class, $property->getName()));
        }

        return $annotation;
    }

    /**
     * @param object|string $data
     *
     * @return UploadableField[]|iterable
     */
    public function getConfiguredProperties($data, bool $skipUploadableCheck = false): iterable
    {
        if (!$skipUploadableCheck && !$this->isConfigured($data)) {
            throw new UnsupportedAnnotationException(sprintf('Cannot get field configuration for %s: is it not configured as Uploadable', \is_string($data) ? $data : \get_class($data)));
        }

        $found = false;
        $reflectionProperties = (new \ReflectionClass($data))->getProperties();
        foreach ($reflectionProperties as $reflectionProperty) {
            try {
                $config = $this->getPropertyConfiguration($reflectionProperty);
                yield $reflectionProperty->getName() => $config;

The expression yield $reflectionProperty->getName() => $config returns the type Generator which is incompatible with the documented return type Silverback\ApiComponentsBundle\Annotation\UploadableField[]|iterable.

                $found = true;
            } catch (InvalidArgumentException $e) {

Consider adding a comment why this CATCH block is empty.

            }
        }
        if (!$found) {
            throw new UnsupportedAnnotationException(sprintf('No field configurations on your Uploadable component %s.', \is_string($data) ? $data : \get_class($data)));
        }
    }
}