ServerFactory::createLocalFilesystem() - Code Metrics - Inspection of "Flysystem v2" - thephpleague/glide - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#300)

unknown

created 2021-01-19 10:35 UTC

ServerFactory::createLocalFilesystem() A

↳ Parent: ServerFactory

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	12
ccs	0
cts	9
cp	0
rs	9.8666
c	0
b	0
f	0
cc	2
nc	2
nop	1
crap	6

<?php

namespace League\Glide;

use Intervention\Image\ImageManager;
use InvalidArgumentException;
use League\Flysystem\Adapter\Local;
use League\Flysystem\Filesystem;
use League\Flysystem\FilesystemInterface;
use League\Flysystem\FilesystemOperator;
use League\Flysystem\Local\LocalFilesystemAdapter;
use League\Glide\Api\Api;
use League\Glide\Manipulators\Background;
use League\Glide\Manipulators\Blur;
use League\Glide\Manipulators\Border;
use League\Glide\Manipulators\Brightness;
use League\Glide\Manipulators\Contrast;
use League\Glide\Manipulators\Crop;
use League\Glide\Manipulators\Encode;
use League\Glide\Manipulators\Filter;
use League\Glide\Manipulators\Flip;
use League\Glide\Manipulators\Gamma;
use League\Glide\Manipulators\Orientation;
use League\Glide\Manipulators\Pixelate;
use League\Glide\Manipulators\Sharpen;
use League\Glide\Manipulators\Size;
use League\Glide\Manipulators\Watermark;
use League\Glide\Responses\ResponseFactoryInterface;

class ServerFactory
{
    /**
     * Configuration parameters.
     * @var array
     */
    protected $config;

    /**
     * Create ServerFactory instance.
     * @param array $config Configuration parameters.
     */
    public function __construct(array $config = [])
    {
        $this->config = $config;
    }

    /**
     * Get configured server.
     * @return Server Configured Glide server.
     */
    public function getServer()
    {
        $server = new Server(
            $this->getSource(),
            $this->getCache(),
            $this->getApi()
        );

        $server->setSourcePathPrefix($this->getSourcePathPrefix());
        $server->setCachePathPrefix($this->getCachePathPrefix());
        $server->setGroupCacheInFolders($this->getGroupCacheInFolders());
        $server->setCacheWithFileExtensions($this->getCacheWithFileExtensions());
        $server->setDefaults($this->getDefaults());
        $server->setPresets($this->getPresets());
        $server->setBaseUrl($this->getBaseUrl());
        $server->setResponseFactory($this->getResponseFactory());

        return $server;
    }

    /**
     * Create local filesystem for Flysystem v1 or v2
     * @param  string  $path Filesystem path
     * @return FilesystemInterface|FilesystemOperator
     */
    private function createLocalFilesystem(string $path)
    {
        if(interface_exists(FilesystemInterface::class)) {
            return new Filesystem(
                new Local($path)
            );
        }

        return new Filesystem(
            new LocalFilesystemAdapter($path)
        );
    }

    /**
     * Get source file system.
     * @return FilesystemInterface|FilesystemOperator Source file system.
     */
    public function getSource()
    {
        if (!isset($this->config['source'])) {
            throw new InvalidArgumentException('A "source" file system must be set.');
        }

        if (is_string($this->config['source'])) {
            return $this->createLocalFilesystem($this->config['source']);
        }

        return $this->config['source'];
    }

    /**
     * Get source path prefix.
     * @return string|null Source path prefix.
     */
    public function getSourcePathPrefix()
    {
        if (isset($this->config['source_path_prefix'])) {
            return $this->config['source_path_prefix'];
        }
    }

    /**
     * Get cache file system.
     * @return FilesystemInterface|FilesystemOperator Cache file system.
     */
    public function getCache()
    {
        if (!isset($this->config['cache'])) {
            throw new InvalidArgumentException('A "cache" file system must be set.');
        }

        if (is_string($this->config['cache'])) {
            return $this->createLocalFilesystem($this->config['cache']);
        }

        return $this->config['cache'];
    }

    /**
     * Get cache path prefix.
     * @return string|null Cache path prefix.
     */
    public function getCachePathPrefix()
    {
        if (isset($this->config['cache_path_prefix'])) {
            return $this->config['cache_path_prefix'];
        }
    }

    /**
     * Get the group cache in folders setting.
     * @return bool Whether to group cache in folders.
     */
    public function getGroupCacheInFolders()
    {
        if (isset($this->config['group_cache_in_folders'])) {
            return $this->config['group_cache_in_folders'];
        }

        return true;
    }

    /**
     * Get the cache with file extensions setting.
     * @return bool Whether to cache with file extensions.
     */
    public function getCacheWithFileExtensions()
    {
        if (isset($this->config['cache_with_file_extensions'])) {
            return $this->config['cache_with_file_extensions'];
        }

        return false;
    }

    /**
     * Get watermarks file system.
     * @return FilesystemInterface|FilesystemOperator|null Watermarks file system.
     */
    public function getWatermarks()
    {
        if (!isset($this->config['watermarks'])) {
            return;
        }

        if (is_string($this->config['watermarks'])) {
            return $this->createLocalFilesystem($this->config['watermarks']);
        }

        return $this->config['watermarks'];
    }

    /**
     * Get watermarks path prefix.
     * @return string|null Watermarks path prefix.
     */
    public function getWatermarksPathPrefix()
    {
        if (isset($this->config['watermarks_path_prefix'])) {
            return $this->config['watermarks_path_prefix'];
        }
    }

    /**
     * Get image manipulation API.
     * @return Api Image manipulation API.
     */
    public function getApi()
    {
        return new Api(
            $this->getImageManager(),
            $this->getManipulators()
        );
    }

    /**
     * Get Intervention image manager.
     * @return ImageManager Intervention image manager.
     */
    public function getImageManager()
    {
        $driver = 'gd';

        if (isset($this->config['driver'])) {
            $driver = $this->config['driver'];
        }

        return new ImageManager([
            'driver' => $driver,
        ]);
    }

    /**
     * Get image manipulators.
     * @return array Image manipulators.
     */
    public function getManipulators()
    {
        return [
            new Orientation(),
            new Crop(),
            new Size($this->getMaxImageSize()),
            new Brightness(),
            new Contrast(),
            new Gamma(),
            new Sharpen(),
            new Filter(),
            new Flip(),
            new Blur(),
            new Pixelate(),
            new Watermark($this->getWatermarks(), $this->getWatermarksPathPrefix()),
            new Background(),
            new Border(),
            new Encode(),
        ];
    }

    /**
     * Get maximum image size.
     * @return int|null Maximum image size.
     */
    public function getMaxImageSize()
    {
        if (isset($this->config['max_image_size'])) {
            return $this->config['max_image_size'];
        }
    }

    /**
     * Get default image manipulations.
     * @return array Default image manipulations.
     */
    public function getDefaults()
    {
        if (isset($this->config['defaults'])) {
            return $this->config['defaults'];
        }

        return [];
    }

    /**
     * Get preset image manipulations.
     * @return array Preset image manipulations.
     */
    public function getPresets()
    {
        if (isset($this->config['presets'])) {
            return $this->config['presets'];
        }

        return [];
    }

    /**
     * Get base URL.
     * @return string|null Base URL.
     */
    public function getBaseUrl()
    {
        if (isset($this->config['base_url'])) {
            return $this->config['base_url'];
        }
    }

    /**
     * Get response factory.
     * @return ResponseFactoryInterface|null Response factory.
     */
    public function getResponseFactory()
    {
        if (isset($this->config['response'])) {
            return $this->config['response'];
        }
    }

    /**
     * Create configured server.
     * @param  array  $config Configuration parameters.
     * @return Server Configured server.
     */
    public static function create(array $config = [])
    {
        return (new self($config))->getServer();
    }
}


1			<?php
2
3			namespace League\Glide;
4
5			use Intervention\Image\ImageManager;
6			use InvalidArgumentException;
7			use League\Flysystem\Adapter\Local;
8			use League\Flysystem\Filesystem;
9			use League\Flysystem\FilesystemInterface;
10			use League\Flysystem\FilesystemOperator;
11			use League\Flysystem\Local\LocalFilesystemAdapter;
12			use League\Glide\Api\Api;
13			use League\Glide\Manipulators\Background;
14			use League\Glide\Manipulators\Blur;
15			use League\Glide\Manipulators\Border;
16			use League\Glide\Manipulators\Brightness;
17			use League\Glide\Manipulators\Contrast;
18			use League\Glide\Manipulators\Crop;
19			use League\Glide\Manipulators\Encode;
20			use League\Glide\Manipulators\Filter;
21			use League\Glide\Manipulators\Flip;
22			use League\Glide\Manipulators\Gamma;
23			use League\Glide\Manipulators\Orientation;
24			use League\Glide\Manipulators\Pixelate;
25			use League\Glide\Manipulators\Sharpen;
26			use League\Glide\Manipulators\Size;
27			use League\Glide\Manipulators\Watermark;
28			use League\Glide\Responses\ResponseFactoryInterface;
29
30			class ServerFactory
31			{
32			/**
33			* Configuration parameters.
34			* @var array
35			*/
36			protected $config;
37
38			/**
39			* Create ServerFactory instance.
40			* @param array $config Configuration parameters.
41			*/
42			public function __construct(array $config = [])
43			{
44			$this->config = $config;
45			}
46
47			/**
48			* Get configured server.
49			* @return Server Configured Glide server.
50			*/
51			public function getServer()
52			{
53			$server = new Server(
54			$this->getSource(),
55			$this->getCache(),
56			$this->getApi()
57			);
58
59			$server->setSourcePathPrefix($this->getSourcePathPrefix());
60			$server->setCachePathPrefix($this->getCachePathPrefix());
61			$server->setGroupCacheInFolders($this->getGroupCacheInFolders());
62			$server->setCacheWithFileExtensions($this->getCacheWithFileExtensions());
63			$server->setDefaults($this->getDefaults());
64			$server->setPresets($this->getPresets());
65			$server->setBaseUrl($this->getBaseUrl());
66			$server->setResponseFactory($this->getResponseFactory());
67
68			return $server;
69			}
70
71			/**
72			* Create local filesystem for Flysystem v1 or v2
73			* @param string $path Filesystem path
74			* @return FilesystemInterface\|FilesystemOperator
75			*/
76			private function createLocalFilesystem(string $path)
77			{
78			if(interface_exists(FilesystemInterface::class)) {
79			return new Filesystem(
80			new Local($path)
81			);
82			}
83
84			return new Filesystem(
85			new LocalFilesystemAdapter($path)
86			);
87			}
88
89			/**
90			* Get source file system.
91			* @return FilesystemInterface\|FilesystemOperator Source file system.
92			*/
93			public function getSource()
94			{
95			if (!isset($this->config['source'])) {
96			throw new InvalidArgumentException('A "source" file system must be set.');
97			}
98
99			if (is_string($this->config['source'])) {
100			return $this->createLocalFilesystem($this->config['source']);
101			}
102
103			return $this->config['source'];
104			}
105
106			/**
107			* Get source path prefix.
108			* @return string\|null Source path prefix.
109			*/
110			public function getSourcePathPrefix()
111			{
112			if (isset($this->config['source_path_prefix'])) {
113			return $this->config['source_path_prefix'];
114			}
115			}
116
117			/**
118			* Get cache file system.
119			* @return FilesystemInterface\|FilesystemOperator Cache file system.
120			*/
121			public function getCache()
122			{
123			if (!isset($this->config['cache'])) {
124			throw new InvalidArgumentException('A "cache" file system must be set.');
125			}
126
127			if (is_string($this->config['cache'])) {
128			return $this->createLocalFilesystem($this->config['cache']);
129			}
130
131			return $this->config['cache'];
132			}
133
134			/**
135			* Get cache path prefix.
136			* @return string\|null Cache path prefix.
137			*/
138			public function getCachePathPrefix()
139			{
140			if (isset($this->config['cache_path_prefix'])) {
141			return $this->config['cache_path_prefix'];
142			}
143			}
144
145			/**
146			* Get the group cache in folders setting.
147			* @return bool Whether to group cache in folders.
148			*/
149			public function getGroupCacheInFolders()
150			{
151			if (isset($this->config['group_cache_in_folders'])) {
152			return $this->config['group_cache_in_folders'];
153			}
154
155			return true;
156			}
157
158			/**
159			* Get the cache with file extensions setting.
160			* @return bool Whether to cache with file extensions.
161			*/
162			public function getCacheWithFileExtensions()
163			{
164			if (isset($this->config['cache_with_file_extensions'])) {
165			return $this->config['cache_with_file_extensions'];
166			}
167
168			return false;
169			}
170
171			/**
172			* Get watermarks file system.
173			* @return FilesystemInterface\|FilesystemOperator\|null Watermarks file system.
174			*/
175			public function getWatermarks()
176			{
177			if (!isset($this->config['watermarks'])) {
178			return;
179			}
180
181			if (is_string($this->config['watermarks'])) {
182			return $this->createLocalFilesystem($this->config['watermarks']);
183			}
184
185			return $this->config['watermarks'];
186			}
187
188			/**
189			* Get watermarks path prefix.
190			* @return string\|null Watermarks path prefix.
191			*/
192			public function getWatermarksPathPrefix()
193			{
194			if (isset($this->config['watermarks_path_prefix'])) {
195			return $this->config['watermarks_path_prefix'];
196			}
197			}
198
199			/**
200			* Get image manipulation API.
201			* @return Api Image manipulation API.
202			*/
203			public function getApi()
204			{
205			return new Api(
206			$this->getImageManager(),
207			$this->getManipulators()
208			);
209			}
210
211			/**
212			* Get Intervention image manager.
213			* @return ImageManager Intervention image manager.
214			*/
215			public function getImageManager()
216			{
217			$driver = 'gd';
218
219			if (isset($this->config['driver'])) {
220			$driver = $this->config['driver'];
221			}
222
223			return new ImageManager([
224			'driver' => $driver,
225			]);
226			}
227
228			/**
229			* Get image manipulators.
230			* @return array Image manipulators.
231			*/
232			public function getManipulators()
233			{
234			return [
235			new Orientation(),
236			new Crop(),
237			new Size($this->getMaxImageSize()),
238			new Brightness(),
239			new Contrast(),
240			new Gamma(),
241			new Sharpen(),
242			new Filter(),
243			new Flip(),
244			new Blur(),
245			new Pixelate(),
246			new Watermark($this->getWatermarks(), $this->getWatermarksPathPrefix()),
247			new Background(),
248			new Border(),
249			new Encode(),
250			];
251			}
252
253			/**
254			* Get maximum image size.
255			* @return int\|null Maximum image size.
256			*/
257			public function getMaxImageSize()
258			{
259			if (isset($this->config['max_image_size'])) {
260			return $this->config['max_image_size'];
261			}
262			}
263
264			/**
265			* Get default image manipulations.
266			* @return array Default image manipulations.
267			*/
268			public function getDefaults()
269			{
270			if (isset($this->config['defaults'])) {
271			return $this->config['defaults'];
272			}
273
274			return [];
275			}
276
277			/**
278			* Get preset image manipulations.
279			* @return array Preset image manipulations.
280			*/
281			public function getPresets()
282			{
283			if (isset($this->config['presets'])) {
284			return $this->config['presets'];
285			}
286
287			return [];
288			}
289
290			/**
291			* Get base URL.
292			* @return string\|null Base URL.
293			*/
294			public function getBaseUrl()
295			{
296			if (isset($this->config['base_url'])) {
297			return $this->config['base_url'];
298			}
299			}
300
301			/**
302			* Get response factory.
303			* @return ResponseFactoryInterface\|null Response factory.
304			*/
305			public function getResponseFactory()
306			{
307			if (isset($this->config['response'])) {
308			return $this->config['response'];
309			}
310			}
311
312			/**
313			* Create configured server.
314			* @param array $config Configuration parameters.
315			* @return Server Configured server.
316			*/
317			public static function create(array $config = [])
318			{
319			return (new self($config))->getServer();
320			}
321			}
322

thephpleague / glide

Pull Request — master (#300)

ServerFactory::createLocalFilesystem() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like