FileManipulator::createDerivedFiles() - Code Metrics - spatie/laravel-medialibrary - Measure and Improve Code Quality continuously with Scrutinizer

FileManipulator::createDerivedFiles() A
last analyzed 2020-01-25 09:30 UTC

↳ Parent: FileManipulator

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	22
rs	9.568
c	0
b	0
f	0
cc	3
nc	4
nop	3

<?php

namespace Spatie\MediaLibrary;

use Illuminate\Contracts\Bus\Dispatcher;
use Illuminate\Support\Facades\File;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use Illuminate\Support\Str;
use Spatie\MediaLibrary\Conversion\Conversion;
use Spatie\MediaLibrary\Conversion\ConversionCollection;
use Spatie\MediaLibrary\Events\ConversionHasBeenCompleted;
use Spatie\MediaLibrary\Events\ConversionWillStart;
use Spatie\MediaLibrary\Filesystem\Filesystem;
use Spatie\MediaLibrary\Helpers\File as MediaLibraryFileHelper;
use Spatie\MediaLibrary\Helpers\ImageFactory;
use Spatie\MediaLibrary\Helpers\TemporaryDirectory;
use Spatie\MediaLibrary\ImageGenerators\ImageGenerator;
use Spatie\MediaLibrary\Jobs\PerformConversions;
use Spatie\MediaLibrary\Models\Media;
use Spatie\MediaLibrary\ResponsiveImages\ResponsiveImageGenerator;
use Storage;

class FileManipulator
{
    /**
     * Create all derived files for the given media.
     *
     * @param \Spatie\MediaLibrary\Models\Media $media
     * @param array $only
     * @param bool $onlyMissing
     */
    public function createDerivedFiles(Media $media, array $only = [], bool $onlyMissing = false)
    {
        $profileCollection = ConversionCollection::createForMedia($media);

        if (! empty($only)) {
            $profileCollection = $profileCollection->filter(function ($collection) use ($only) {
                return in_array($collection->getName(), $only);
            });
        }

        $this->performConversions(
            $profileCollection->getNonQueuedConversions($media->collection_name),
            $media,
            $onlyMissing
        );

        $queuedConversions = $profileCollection->getQueuedConversions($media->collection_name);

        if ($queuedConversions->isNotEmpty()) {
            $this->dispatchQueuedConversions($media, $queuedConversions, $onlyMissing);
        }
    }

    /**
     * Perform the given conversions for the given media.
     *
     * @param \Spatie\MediaLibrary\Conversion\ConversionCollection $conversions
     * @param \Spatie\MediaLibrary\Models\Media $media
     * @param bool $onlyMissing
     */
    public function performConversions(ConversionCollection $conversions, Media $media, bool $onlyMissing = false)
    {
        if ($conversions->isEmpty()) {
            return;
        }

        $imageGenerator = $this->determineImageGenerator($media);

        if (! $imageGenerator) {
            return;
        }

        $temporaryDirectory = TemporaryDirectory::create();

        $copiedOriginalFile = app(Filesystem::class)->copyFromMediaLibrary(
            $media,
            $temporaryDirectory->path(Str::random(16).'.'.$media->extension)
        );

        $conversions
            ->reject(function (Conversion $conversion) use ($onlyMissing, $media) {
                $relativePath = $media->getPath($conversion->getName());

                $rootPath = config('filesystems.disks.'.$media->disk.'.root');

                if ($rootPath) {
                    $relativePath = str_replace($rootPath, '', $relativePath);
                }

                return $onlyMissing && Storage::disk($media->disk)->exists($relativePath);
            })
            ->each(function (Conversion $conversion) use ($media, $imageGenerator, $copiedOriginalFile) {
                event(new ConversionWillStart($media, $conversion, $copiedOriginalFile));

                $copiedOriginalFile = $imageGenerator->convert($copiedOriginalFile, $conversion);
$x = 1;
$callable = function() use ($x) {
    $x = 2; // Not visible in outer scope. If you would like this, how
            // about using a different variable name than $x?
};

$callable();
var_dump($x); // integer(1)

                $manipulationResult = $this->performManipulations($media, $conversion, $copiedOriginalFile);

                $newFileName = $conversion->getConversionFile($media->file_name);

                $renamedFile = MediaLibraryFileHelper::renameInDirectory($manipulationResult, $newFileName);

                if ($conversion->shouldGenerateResponsiveImages()) {
                    app(ResponsiveImageGenerator::class)->generateResponsiveImagesForConversion(
                        $media,
                        $conversion,
                        $renamedFile
                    );
                }

                app(Filesystem::class)->copyToMediaLibrary($renamedFile, $media, 'conversions');

                $media->markAsConversionGenerated($conversion->getName(), true);

                event(new ConversionHasBeenCompleted($media, $conversion));
            });

        $temporaryDirectory->delete();
    }

    public function performManipulations(Media $media, Conversion $conversion, string $imageFile): string
    {
        if ($conversion->getManipulations()->isEmpty()) {
            return $imageFile;
        }

        $conversionTempFile = pathinfo($imageFile, PATHINFO_DIRNAME).'/'.Str::random(16)
            .$conversion->getName()
            .'.'
            .$media->extension;

        File::copy($imageFile, $conversionTempFile);

        $supportedFormats = ['jpg', 'pjpg', 'png', 'gif'];
        if ($conversion->shouldKeepOriginalImageFormat() && in_array($media->extension, $supportedFormats)) {
            $conversion->format($media->extension);

        }

        ImageFactory::load($conversionTempFile)
            ->manipulate($conversion->getManipulations())
            ->save();

        return $conversionTempFile;
    }

    protected function dispatchQueuedConversions(Media $media, ConversionCollection $queuedConversions, bool $onlyMissing = false)
    {
        $performConversionsJobClass = config('medialibrary.jobs.perform_conversions', PerformConversions::class);

        $job = new $performConversionsJobClass($queuedConversions, $media, $onlyMissing);

        if ($customQueue = config('medialibrary.queue_name')) {
            $job->onQueue($customQueue);
        }

        app(Dispatcher::class)->dispatch($job);
    }

    /**
     * @param \Spatie\MediaLibrary\Models\Media $media
     *
     * @return \Spatie\MediaLibrary\ImageGenerators\ImageGenerator|null
     */
    public function determineImageGenerator(Media $media)
    {
        return $media->getImageGenerators()
            ->map(function (string $imageGeneratorClassName) {
                return app($imageGeneratorClassName);
            })
            ->first(function (ImageGenerator $imageGenerator) use ($media) {
                return $imageGenerator->canConvert($media);
            });
    }
}


1			<?php
2
3			namespace Spatie\MediaLibrary;
4
5			use Illuminate\Contracts\Bus\Dispatcher;
6			use Illuminate\Support\Facades\File;
			0 ignored issues – show Bug introduced 2018-03-17 08:57 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `Spatie\MediaLibrary\File`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
7			use Illuminate\Support\Str;
8			use Spatie\MediaLibrary\Conversion\Conversion;
9			use Spatie\MediaLibrary\Conversion\ConversionCollection;
10			use Spatie\MediaLibrary\Events\ConversionHasBeenCompleted;
11			use Spatie\MediaLibrary\Events\ConversionWillStart;
12			use Spatie\MediaLibrary\Filesystem\Filesystem;
13			use Spatie\MediaLibrary\Helpers\File as MediaLibraryFileHelper;
14			use Spatie\MediaLibrary\Helpers\ImageFactory;
15			use Spatie\MediaLibrary\Helpers\TemporaryDirectory;
16			use Spatie\MediaLibrary\ImageGenerators\ImageGenerator;
17			use Spatie\MediaLibrary\Jobs\PerformConversions;
18			use Spatie\MediaLibrary\Models\Media;
19			use Spatie\MediaLibrary\ResponsiveImages\ResponsiveImageGenerator;
20			use Storage;
21
22			class FileManipulator
23			{
24			/**
25			* Create all derived files for the given media.
26			*
27			* @param \Spatie\MediaLibrary\Models\Media $media
28			* @param array $only
29			* @param bool $onlyMissing
30			*/
31			public function createDerivedFiles(Media $media, array $only = [], bool $onlyMissing = false)
32			{
33			$profileCollection = ConversionCollection::createForMedia($media);
34
35			if (! empty($only)) {
36			$profileCollection = $profileCollection->filter(function ($collection) use ($only) {
37			return in_array($collection->getName(), $only);
38			});
39			}
40
41			$this->performConversions(
42			$profileCollection->getNonQueuedConversions($media->collection_name),
43			$media,
44			$onlyMissing
45			);
46
47			$queuedConversions = $profileCollection->getQueuedConversions($media->collection_name);
48
49			if ($queuedConversions->isNotEmpty()) {
50			$this->dispatchQueuedConversions($media, $queuedConversions, $onlyMissing);
51			}
52			}
53
54			/**
55			* Perform the given conversions for the given media.
56			*
57			* @param \Spatie\MediaLibrary\Conversion\ConversionCollection $conversions
58			* @param \Spatie\MediaLibrary\Models\Media $media
59			* @param bool $onlyMissing
60			*/
61			public function performConversions(ConversionCollection $conversions, Media $media, bool $onlyMissing = false)
62			{
63			if ($conversions->isEmpty()) {
64			return;
65			}
66
67			$imageGenerator = $this->determineImageGenerator($media);
68
69			if (! $imageGenerator) {
70			return;
71			}
72
73			$temporaryDirectory = TemporaryDirectory::create();
74
75			$copiedOriginalFile = app(Filesystem::class)->copyFromMediaLibrary(
76			$media,
77			$temporaryDirectory->path(Str::random(16).'.'.$media->extension)
78			);
79
80			$conversions
81			->reject(function (Conversion $conversion) use ($onlyMissing, $media) {
82			$relativePath = $media->getPath($conversion->getName());
83
84			$rootPath = config('filesystems.disks.'.$media->disk.'.root');
85
86			if ($rootPath) {
87			$relativePath = str_replace($rootPath, '', $relativePath);
88			}
89
90			return $onlyMissing && Storage::disk($media->disk)->exists($relativePath);
91			})
92			->each(function (Conversion $conversion) use ($media, $imageGenerator, $copiedOriginalFile) {
93			event(new ConversionWillStart($media, $conversion, $copiedOriginalFile));
94
95			$copiedOriginalFile = $imageGenerator->convert($copiedOriginalFile, $conversion);
			0 ignored issues – show Bug introduced 2017-10-24 15:33 UTC by Report Bug Copy Issue Report Consider using a different name than the imported variable `$copiedOriginalFile`, or did you forget to import by reference? It seems like you are assigning to a variable which was imported through a `use` statement which was not imported by reference. For clarity, we suggest to use a different name or import by reference depending on whether you would like to have the change visibile in outer-scope. Change not visible in outer-scope $x = 1; $callable = function() use ($x) { $x = 2; // Not visible in outer scope. If you would like this, how // about using a different variable name than $x? }; $callable(); var_dump($x); // integer(1) Change visible in outer-scope $x = 1; $callable = function() use (&$x) { $x = 2; }; $callable(); var_dump($x); // integer(2) Loading history...
96
97			$manipulationResult = $this->performManipulations($media, $conversion, $copiedOriginalFile);
98
99			$newFileName = $conversion->getConversionFile($media->file_name);
100
101			$renamedFile = MediaLibraryFileHelper::renameInDirectory($manipulationResult, $newFileName);
102
103			if ($conversion->shouldGenerateResponsiveImages()) {
104			app(ResponsiveImageGenerator::class)->generateResponsiveImagesForConversion(
105			$media,
106			$conversion,
107			$renamedFile
108			);
109			}
110
111			app(Filesystem::class)->copyToMediaLibrary($renamedFile, $media, 'conversions');
112
113			$media->markAsConversionGenerated($conversion->getName(), true);
114
115			event(new ConversionHasBeenCompleted($media, $conversion));
116			});
117
118			$temporaryDirectory->delete();
119			}
120
121			public function performManipulations(Media $media, Conversion $conversion, string $imageFile): string
122			{
123			if ($conversion->getManipulations()->isEmpty()) {
124			return $imageFile;
125			}
126
127			$conversionTempFile = pathinfo($imageFile, PATHINFO_DIRNAME).'/'.Str::random(16)
128			.$conversion->getName()
129			.'.'
130			.$media->extension;
131
132			File::copy($imageFile, $conversionTempFile);
133
134			$supportedFormats = ['jpg', 'pjpg', 'png', 'gif'];
135			if ($conversion->shouldKeepOriginalImageFormat() && in_array($media->extension, $supportedFormats)) {
136			$conversion->format($media->extension);
			0 ignored issues – show Bug introduced 2017-03-23 13:27 UTC by Report Bug Copy Issue Report The method `format()` does not exist on `Spatie\MediaLibrary\Conversion\Conversion`. Did you maybe mean `keepOriginalImageFormat()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
137			}
138
139			ImageFactory::load($conversionTempFile)
140			->manipulate($conversion->getManipulations())
141			->save();
142
143			return $conversionTempFile;
144			}
145
146			protected function dispatchQueuedConversions(Media $media, ConversionCollection $queuedConversions, bool $onlyMissing = false)
147			{
148			$performConversionsJobClass = config('medialibrary.jobs.perform_conversions', PerformConversions::class);
149
150			$job = new $performConversionsJobClass($queuedConversions, $media, $onlyMissing);
151
152			if ($customQueue = config('medialibrary.queue_name')) {
153			$job->onQueue($customQueue);
154			}
155
156			app(Dispatcher::class)->dispatch($job);
157			}
158
159			/**
160			* @param \Spatie\MediaLibrary\Models\Media $media
161			*
162			* @return \Spatie\MediaLibrary\ImageGenerators\ImageGenerator\|null
163			*/
164			public function determineImageGenerator(Media $media)
165			{
166			return $media->getImageGenerators()
167			->map(function (string $imageGeneratorClassName) {
168			return app($imageGeneratorClassName);
169			})
170			->first(function (ImageGenerator $imageGenerator) use ($media) {
171			return $imageGenerator->canConvert($media);
172			});
173			}
174			}
175

spatie / laravel-medialibrary

FileManipulator::createDerivedFiles() A last analyzed 2020-01-25 09:30 UTC

Complexity

Size

Duplication

Importance

Change not visible in outer-scope

Change visible in outer-scope

Duplication Side-by-Side

Filter issues like

FileManipulator::createDerivedFiles() A
last analyzed 2020-01-25 09:30 UTC