MediaObjectFactory::__construct() - Code Metrics - Inspection of "Feat/url generator" - components-web-app/api-components-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — main (#161)

by Daniel
created 2023-01-24 21:14 UTC
MediaObjectFactory::__construct() A

↳ Parent: MediaObjectFactory
Complexity

Conditions	1
Paths	1
Size

Total Lines	11
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	1
nc	1
nop	8
dl	0
loc	11
ccs	0
cts	2
cp	0
crap	2
rs	10
c	1
b	0
f	0
How to fix Many Parameters

<?php

/*
 * This file is part of the Silverback API Components Bundle Project
 *
 * (c) Daniel West <[email protected]>
 *
 * 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\Factory\Uploadable;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Persistence\ManagerRegistry;
use League\Flysystem\Filesystem;
use League\Flysystem\UnableToReadFile;
use Liip\ImagineBundle\Service\FilterService;
use Silverback\ApiComponentsBundle\Annotation\UploadableField;
use Silverback\ApiComponentsBundle\AttributeReader\UploadableAttributeReader;
use Silverback\ApiComponentsBundle\Entity\Core\FileInfo;
use Silverback\ApiComponentsBundle\Entity\Utility\ImagineFiltersInterface;
use Silverback\ApiComponentsBundle\Exception\InvalidArgumentException;
use Silverback\ApiComponentsBundle\Flysystem\FilesystemProvider;
use Silverback\ApiComponentsBundle\Helper\Uploadable\FileInfoCacheManager;
use Silverback\ApiComponentsBundle\Imagine\FlysystemDataLoader;
use Silverback\ApiComponentsBundle\Model\Uploadable\MediaObject;
use Silverback\ApiComponentsBundle\Utility\ClassMetadataTrait;
use Symfony\Component\DependencyInjection\ServiceLocator;
use Symfony\Component\HttpFoundation\RequestStack;

/**
 * @author Daniel West <[email protected]>
 */
class MediaObjectFactory
{
    use ClassMetadataTrait;

    public function __construct(
        ManagerRegistry $managerRegistry,
        private readonly FileInfoCacheManager $fileInfoCacheManager,
        private readonly UploadableAttributeReader $annotationReader,
        private readonly FilesystemProvider $filesystemProvider,
        private readonly FlysystemDataLoader $flysystemDataLoader,
        private readonly RequestStack $requestStack,
        private readonly ServiceLocator $urlGenerators,
        private readonly ?FilterService $filterService = null
    ) {
        $this->initRegistry($managerRegistry);
    }

    public function createMediaObjects(object $object): ?ArrayCollection
    {
        $collection = new ArrayCollection();
        $classMetadata = $this->getClassMetadata($object);

        $configuredProperties = $this->annotationReader->getConfiguredProperties($object, true);

        foreach ($configuredProperties as $fileProperty => $fieldConfiguration) {
            $propertyMediaObjects = [];
            // todo: we may need to look at the performance of this when getting the components. yes, the response is cached, but even first load on a page with lots of files, could be very bad
            $filesystem = $this->filesystemProvider->getFilesystem($fieldConfiguration->adapter);
            $path = $classMetadata->getFieldValue($object, $fieldConfiguration->property);
            if (!$path) {
                continue;
            }
            if (!$filesystem->fileExists($path)) {
                continue;
            }

            // todo: the content URL perhaps will just be a public URL from the source/CDN instead of via this API download action
//            if ($filesystem instanceof TemporaryUrlGenerator) {
//                // $filesystem->temporaryUrl();
//            }

            $urlGenerator = $this->urlGenerators->get($fieldConfiguration->urlGenerator);
            if (!$urlGenerator instanceof UploadableUrlGeneratorInterface) {
                throw new InvalidArgumentException(sprintf('The url generator provided must implement %s', UploadableUrlGeneratorInterface::class));
            }
            $contentUrl = $urlGenerator->generateUrl($object, $fileProperty, $filesystem, $path);

            // Populate the primary MediaObject
            try {
                $propertyMediaObjects[] = $this->create($filesystem, $path, $contentUrl);
            } catch (UnableToReadFile $exception) {

            }

            array_push($propertyMediaObjects, ...$this->getMediaObjectsForImagineFilters($object, $path, $fieldConfiguration, $fileProperty));

            $collection->set($fileProperty, $propertyMediaObjects);
        }

        return $collection->count() ? $collection : null;
    }

    /**
     * @return MediaObject[]
     */
    private function getMediaObjectsForImagineFilters(object $object, string $path, UploadableField $uploadableField, string $fileProperty): array
    {
        $mediaObjects = [];
        if (!$this->filterService) {
            return $mediaObjects;
        }

        // Let the data loader which should be configured for imagine to know which adapter to use
        $this->flysystemDataLoader->setAdapter($uploadableField->adapter);

        $filters = $uploadableField->imagineFilters;
        if ($object instanceof ImagineFiltersInterface) {
            $request = $this->requestStack->getMainRequest();
            array_push($filters, ...$object->getImagineFilters($fileProperty, $request));
            array_push(/** @scrutinizer ignore-type */ $filters, ...$object->getImagineFilters($fileProperty, $request));
        }

        foreach ($filters as $filter) {
            $resolvedUrl = $this->filterService->getUrlOfFilteredImage($path, $filter);
            $mediaObjects[] = $this->createFromImagine($resolvedUrl, $path, $filter);
        }

        return $mediaObjects;
    }

    private function create(Filesystem $filesystem, string $filename, string $contentUrl): MediaObject
    {
        $mediaObject = new MediaObject();

        $mediaObject->contentUrl = $contentUrl;
        $mediaObject->imagineFilter = null;

        $fileInfo = $this->fileInfoCacheManager->resolveCache($filename);
        if ($fileInfo) {
            return $this->populateMediaObjectFromCache($mediaObject, $fileInfo);
        }

        $mediaObject->fileSize = $filesystem->fileSize($filename);
        $mediaObject->mimeType = $filesystem->mimeType($filename);
        if (str_contains($mediaObject->mimeType, 'image/')) {
            $file = str_replace("\0", '', $filesystem->read($filename));
            if ('image/svg+xml' === $mediaObject->mimeType) {
                $xmlGet = simplexml_load_string($file);
                $xmlAttributes = $xmlGet->attributes();
                $mediaObject->width = $xmlAttributes ? (int) $xmlAttributes->width : null;
                $mediaObject->height = $xmlAttributes ? (int) $xmlAttributes->height : null;
            } else {
                [$mediaObject->width, $mediaObject->height] = @getimagesize($file);
            }
        }

        $fileInfo = new FileInfo($filename, $mediaObject->mimeType, $mediaObject->fileSize, $mediaObject->width, $mediaObject->height);
        $this->fileInfoCacheManager->saveCache($fileInfo);

        return $mediaObject;
    }

    private function createFromImagine(string $contentUrl, string $path, string $imagineFilter): MediaObject
    {
        $mediaObject = new MediaObject();
        $mediaObject->contentUrl = $contentUrl;
        $mediaObject->imagineFilter = $imagineFilter;

        $fileInfo = $this->fileInfoCacheManager->resolveCache($path, $imagineFilter);
        if ($fileInfo) {
            return $this->populateMediaObjectFromCache($mediaObject, $fileInfo);
        }

        // todo: check why we are setting this, from imagine we should know this info I'm guessing
        // todo: should we not save the info to cache as well as above?
        $mediaObject->width = $mediaObject->height = $mediaObject->fileSize = -1;
        $mediaObject->mimeType = '';

        return $mediaObject;
    }

    private function populateMediaObjectFromCache(MediaObject $mediaObject, FileInfo $fileInfo): MediaObject
    {
        $mediaObject->fileSize = $fileInfo->fileSize;
        $mediaObject->mimeType = $fileInfo->mimeType;
        $mediaObject->width = $fileInfo->width;
        $mediaObject->height = $fileInfo->height;

        return $mediaObject;
    }
}

components-web-app / api-components-bundle

Pull Request — main (#161)

MediaObjectFactory::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Many Parameters

Many Parameters

Duplication Side-by-Side

Filter issues like
