DefaultFilesystem::getMediaDirectory() - Code Metrics - Inspection of "add release date" - spatie/laravel-medialibrary - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c2f76d...03586b )

by Freek

created 2018-03-17 08:46 UTC

DefaultFilesystem::getMediaDirectory() B

↳ Parent: DefaultFilesystem

Complexity

Conditions	5
Paths	16

Size

Total Lines	22
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	22
rs	8.6737
c	0
b	0
f	0
cc	5
eloc	11
nc	16
nop	2

<?php

namespace Spatie\MediaLibrary\Filesystem;

use Spatie\MediaLibrary\Models\Media;
use Spatie\MediaLibrary\Helpers\File;
use Spatie\MediaLibrary\FileManipulator;
use Illuminate\Contracts\Filesystem\Factory;
use Spatie\MediaLibrary\Events\MediaHasBeenAdded;
use Spatie\MediaLibrary\PathGenerator\PathGeneratorFactory;

class DefaultFilesystem implements Filesystem
{
    /** @var \Illuminate\Contracts\Filesystem\Factory */
    protected $filesystem;

    /** @var array */
    protected $customRemoteHeaders = [];

    public function __construct(Factory $filesystem)
    {
        $this->filesystem = $filesystem;
    }

    public function add(string $file, Media $media, ?string $targetFileName = null)
    {
        $this->copyToMediaLibrary($file, $media, null, $targetFileName);

        event(new MediaHasBeenAdded($media));

        app(FileManipulator::class)->createDerivedFiles($media);
    }

    public function copyToMediaLibrary(string $pathToFile, Media $media, ?string $type = null, ?string $targetFileName = null)
    {
        $destinationFileName = $targetFileName ?: pathinfo($pathToFile, PATHINFO_BASENAME);

        $destination = $this->getMediaDirectory($media, $type).$destinationFileName;

        $file = fopen($pathToFile, 'r');

        if ($media->getDiskDriverName() === 'local') {
            $this->filesystem
                ->disk($media->disk)
                ->put($destination, $file);

            fclose($file);

            return;
        }

        $this->filesystem
            ->disk($media->disk)
            ->put($destination, $file, $this->getRemoteHeadersForFile($pathToFile));

        if (is_resource($file)) {
            fclose($file);
        }
    }

    public function addCustomRemoteHeaders(array $customRemoteHeaders)
    {
        $this->customRemoteHeaders = $customRemoteHeaders;
    }

    public function getRemoteHeadersForFile(string $file) : array
    {
        $mimeTypeHeader = ['ContentType' => File::getMimeType($file)];

        $extraHeaders = config('medialibrary.remote.extra_headers');

        return array_merge($mimeTypeHeader, $extraHeaders, $this->customRemoteHeaders);
    }

    public function getStream(Media $media)
    {
        $sourceFile = $this->getMediaDirectory($media).'/'.$media->file_name;

        return $this->filesystem->disk($media->disk)->readStream($sourceFile);
    }

    public function copyFromMediaLibrary(Media $media, string $targetFile): string
    {
        touch($targetFile);

        $stream = $this->getStream($media);

        $targetFileStream = fopen($targetFile, 'a');

        while (! feof($stream)) {
            $chunk = fread($stream, 1024);
            fwrite($targetFileStream, $chunk);
        }

        fclose($stream);

        fclose($targetFileStream);

        return $targetFile;
    }

    public function removeAllFiles(Media $media)
    {
        $mediaDirectory = $this->getMediaDirectory($media);

        $conversionsDirectory = $this->getMediaDirectory($media, 'conversions');

        $responsiveImagesDirectory = $this->getMediaDirectory($media, 'responsiveImages');

        collect([$mediaDirectory, $conversionsDirectory, $responsiveImagesDirectory])

            ->each(function ($directory) use ($media) {
                $this->filesystem->disk($media->disk)->deleteDirectory($directory);
            });
    }

    public function removeFile(Media $media, string $path)
    {
        $this->filesystem->disk($media->disk)->delete($path);
    }

    public function renameFile(Media $media, string $oldName)
    {
        $oldFile = $this->getMediaDirectory($media).'/'.$oldName;
        $newFile = $this->getMediaDirectory($media).'/'.$media->file_name;

        $this->filesystem->disk($media->disk)->move($oldFile, $newFile);
    }

    public function getMediaDirectory(Media $media, ?string $type = null) : string
    {
        $pathGenerator = PathGeneratorFactory::create();

        if (!$type) {
            $directory = $pathGenerator->getPath($media);
        }

        if ($type === 'conversions') {
            $directory = $pathGenerator->getPathForConversions($media);
        }

        if ($type === 'responsiveImages') {
            $directory = $pathGenerator->getPathForResponsiveImages($media);
        }

        if (! in_array($media->getDiskDriverName(), ['s3'], true)) {
            $this->filesystem->disk($media->disk)->makeDirectory($directory);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
        }

        return $directory;
    }

    public function getConversionDirectory(Media $media) : string
    {
        return $this->getMediaDirectory($media, 'conversions');
    }

    public function getResponsiveImagesDirectory(Media $media) : string
    {
        return $this->getMediaDirectory($media, 'responsiveImages');
    }
}


1			<?php
2
3			namespace Spatie\MediaLibrary\Filesystem;
4
5			use Spatie\MediaLibrary\Models\Media;
6			use Spatie\MediaLibrary\Helpers\File;
7			use Spatie\MediaLibrary\FileManipulator;
8			use Illuminate\Contracts\Filesystem\Factory;
9			use Spatie\MediaLibrary\Events\MediaHasBeenAdded;
10			use Spatie\MediaLibrary\PathGenerator\PathGeneratorFactory;
11
12			class DefaultFilesystem implements Filesystem
13			{
14			/** @var \Illuminate\Contracts\Filesystem\Factory */
15			protected $filesystem;
16
17			/** @var array */
18			protected $customRemoteHeaders = [];
19
20			public function __construct(Factory $filesystem)
21			{
22			$this->filesystem = $filesystem;
23			}
24
25			public function add(string $file, Media $media, ?string $targetFileName = null)
26			{
27			$this->copyToMediaLibrary($file, $media, null, $targetFileName);
28
29			event(new MediaHasBeenAdded($media));
30
31			app(FileManipulator::class)->createDerivedFiles($media);
32			}
33
34			public function copyToMediaLibrary(string $pathToFile, Media $media, ?string $type = null, ?string $targetFileName = null)
35			{
36			$destinationFileName = $targetFileName ?: pathinfo($pathToFile, PATHINFO_BASENAME);
37
38			$destination = $this->getMediaDirectory($media, $type).$destinationFileName;
39
40			$file = fopen($pathToFile, 'r');
41
42			if ($media->getDiskDriverName() === 'local') {
43			$this->filesystem
44			->disk($media->disk)
45			->put($destination, $file);
46
47			fclose($file);
48
49			return;
50			}
51
52			$this->filesystem
53			->disk($media->disk)
54			->put($destination, $file, $this->getRemoteHeadersForFile($pathToFile));
55
56			if (is_resource($file)) {
57			fclose($file);
58			}
59			}
60
61			public function addCustomRemoteHeaders(array $customRemoteHeaders)
62			{
63			$this->customRemoteHeaders = $customRemoteHeaders;
64			}
65
66			public function getRemoteHeadersForFile(string $file) : array
67			{
68			$mimeTypeHeader = ['ContentType' => File::getMimeType($file)];
69
70			$extraHeaders = config('medialibrary.remote.extra_headers');
71
72			return array_merge($mimeTypeHeader, $extraHeaders, $this->customRemoteHeaders);
73			}
74
75			public function getStream(Media $media)
76			{
77			$sourceFile = $this->getMediaDirectory($media).'/'.$media->file_name;
78
79			return $this->filesystem->disk($media->disk)->readStream($sourceFile);
80			}
81
82			public function copyFromMediaLibrary(Media $media, string $targetFile): string
83			{
84			touch($targetFile);
85
86			$stream = $this->getStream($media);
87
88			$targetFileStream = fopen($targetFile, 'a');
89
90			while (! feof($stream)) {
91			$chunk = fread($stream, 1024);
92			fwrite($targetFileStream, $chunk);
93			}
94
95			fclose($stream);
96
97			fclose($targetFileStream);
98
99			return $targetFile;
100			}
101
102			public function removeAllFiles(Media $media)
103			{
104			$mediaDirectory = $this->getMediaDirectory($media);
105
106			$conversionsDirectory = $this->getMediaDirectory($media, 'conversions');
107
108			$responsiveImagesDirectory = $this->getMediaDirectory($media, 'responsiveImages');
109
110			collect([$mediaDirectory, $conversionsDirectory, $responsiveImagesDirectory])
111
112			->each(function ($directory) use ($media) {
113			$this->filesystem->disk($media->disk)->deleteDirectory($directory);
114			});
115			}
116
117			public function removeFile(Media $media, string $path)
118			{
119			$this->filesystem->disk($media->disk)->delete($path);
120			}
121
122			public function renameFile(Media $media, string $oldName)
123			{
124			$oldFile = $this->getMediaDirectory($media).'/'.$oldName;
125			$newFile = $this->getMediaDirectory($media).'/'.$media->file_name;
126
127			$this->filesystem->disk($media->disk)->move($oldFile, $newFile);
128			}
129
130			public function getMediaDirectory(Media $media, ?string $type = null) : string
131			{
132			$pathGenerator = PathGeneratorFactory::create();
133
134			if (!$type) {
135			$directory = $pathGenerator->getPath($media);
136			}
137
138			if ($type === 'conversions') {
139			$directory = $pathGenerator->getPathForConversions($media);
140			}
141
142			if ($type === 'responsiveImages') {
143			$directory = $pathGenerator->getPathForResponsiveImages($media);
144			}
145
146			if (! in_array($media->getDiskDriverName(), ['s3'], true)) {
147			$this->filesystem->disk($media->disk)->makeDirectory($directory);
			0 ignored issues – show Bug introduced 2018-03-17 08:57 UTC by Report Bug Copy Issue Report The variable `$directory` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
148			}
149
150			return $directory;
151			}
152
153			public function getConversionDirectory(Media $media) : string
154			{
155			return $this->getMediaDirectory($media, 'conversions');
156			}
157
158			public function getResponsiveImagesDirectory(Media $media) : string
159			{
160			return $this->getMediaDirectory($media, 'responsiveImages');
161			}
162			}
163

spatie / laravel-medialibrary

Push — master ( c2f76d...03586b )

DefaultFilesystem::getMediaDirectory() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like