DataManager::getDefaultImageUrl() - Code Metrics - Inspection of "Fix Mime deprecations for Symfony 4.3" - liip/LiipImagineBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1217)

unknown

created 2019-08-27 21:29 UTC

DataManager::getDefaultImageUrl() A

↳ Parent: DataManager

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	13
rs	9.8333
cc	3
nc	3
nop	1

<?php

/*
 * This file is part of the `liip/LiipImagineBundle` project.
 *
 * (c) https://github.com/liip/LiipImagineBundle/graphs/contributors
 *
 * For the full copyright and license information, please view the LICENSE.md
 * file that was distributed with this source code.
 */

namespace Liip\ImagineBundle\Imagine\Data;

use Liip\ImagineBundle\Binary\BinaryInterface;
use Liip\ImagineBundle\Binary\Loader\LoaderInterface;
use Liip\ImagineBundle\Binary\MimeTypeGuesserInterface;
use Liip\ImagineBundle\Imagine\Filter\FilterConfiguration;
use Liip\ImagineBundle\Model\Binary;
use Symfony\Component\HttpFoundation\File\MimeType\ExtensionGuesserInterface as DeprecatedExtensionGuesserInterface;
use Symfony\Component\Mime\MimeTypesInterface;

class DataManager
{
    /**
     * @var MimeTypeGuesserInterface
     */
    protected $mimeTypeGuesser;

    /**
     * @var DeprecatedExtensionGuesserInterface|MimeTypesInterface
     */
    protected $extensionGuesser;

    /**
     * @var FilterConfiguration
     */
    protected $filterConfig;

    /**
     * @var string|null
     */
    protected $defaultLoader;

    /**
     * @var string|null
     */
    protected $globalDefaultImage;

    /**
     * @var LoaderInterface[]
     */
    protected $loaders = [];

    /**
     * @param MimeTypeGuesserInterface                               $mimeTypeGuesser
     * @param DeprecatedExtensionGuesserInterface|MimeTypesInterface $extensionGuesser
     * @param FilterConfiguration                                    $filterConfig
     * @param string                                                 $defaultLoader
     * @param string                                                 $globalDefaultImage
     */
    public function __construct(
        MimeTypeGuesserInterface $mimeTypeGuesser,
        $extensionGuesser,
        FilterConfiguration $filterConfig,
        $defaultLoader = null,
        $globalDefaultImage = null
    ) {
        if (interface_exists(MimeTypesInterface::class) && $extensionGuesser instanceof DeprecatedExtensionGuesserInterface) {
            @trigger_error(sprintf('Passing a %s to "%s()" is deprecated since Symfony 4.3, pass a "%s" instead.', DeprecatedExtensionGuesserInterface::class, __METHOD__, MimeTypesInterface::class), E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        }

        $this->mimeTypeGuesser = $mimeTypeGuesser;
        $this->filterConfig = $filterConfig;
        $this->defaultLoader = $defaultLoader;
        $this->extensionGuesser = $extensionGuesser;
        $this->globalDefaultImage = $globalDefaultImage;
    }

    /**
     * Adds a loader to retrieve images for the given filter.
     *
     * @param string          $filter
     * @param LoaderInterface $loader
     */
    public function addLoader($filter, LoaderInterface $loader)
    {
        $this->loaders[$filter] = $loader;
    }

    /**
     * Returns a loader previously attached to the given filter.
     *
     * @param string $filter
     *
     * @throws \InvalidArgumentException
     *
     * @return LoaderInterface
     */
    public function getLoader($filter)
    {
        $config = $this->filterConfig->get($filter);

        $loaderName = empty($config['data_loader']) ? $this->defaultLoader : $config['data_loader'];

        if (!isset($this->loaders[$loaderName])) {
            throw new \InvalidArgumentException(sprintf(
                'Could not find data loader "%s" for "%s" filter type',
                $loaderName,
                $filter
            ));
        }

        return $this->loaders[$loaderName];
    }

    /**
     * Retrieves an image with the given filter applied.
     *
     * @param string $filter
     * @param string $path
     *
     * @throws \LogicException
     *
     * @return BinaryInterface
     */
    public function find($filter, $path)
    {
        $loader = $this->getLoader($filter);

        $binary = $loader->find($path);
        if (!$binary instanceof BinaryInterface) {
            $mimeType = $this->mimeTypeGuesser->guess($binary);

            $extension = $this->getExtension($mimeType);
            $binary = new Binary(
                $binary,
                $mimeType,
                $extension
            );
        }

        if (null === $binary->getMimeType()) {
            throw new \LogicException(sprintf('The mime type of image %s was not guessed.', $path));
        }

        if (0 !== mb_strpos($binary->getMimeType(), 'image/')) {
            throw new \LogicException(sprintf('The mime type of image %s must be image/xxx got %s.', $path, $binary->getMimeType()));
        }

        return $binary;
    }

    /**
     * Get default image url with the given filter applied.
     *
     * @param string $filter
     *
     * @return string|null
     */
    public function getDefaultImageUrl($filter)
    {
        $config = $this->filterConfig->get($filter);

        $defaultImage = null;
        if (false === empty($config['default_image'])) {
            $defaultImage = $config['default_image'];
        } elseif (!empty($this->globalDefaultImage)) {
            $defaultImage = $this->globalDefaultImage;
        }

        return $defaultImage;
    }

    private function getExtension(?string $mimeType): ?string
    {
        if ($this->extensionGuesser instanceof DeprecatedExtensionGuesserInterface) {
            return $this->extensionGuesser->guess($mimeType);
        }

        if (null === $mimeType) {
            return null;
        }

        return $this->extensionGuesser->getExtensions($mimeType)[0] ?? null;
    }
}


1			<?php
2
3			/*
4			* This file is part of the `liip/LiipImagineBundle` project.
5			*
6			* (c) https://github.com/liip/LiipImagineBundle/graphs/contributors
7			*
8			* For the full copyright and license information, please view the LICENSE.md
9			* file that was distributed with this source code.
10			*/
11
12			namespace Liip\ImagineBundle\Imagine\Data;
13
14			use Liip\ImagineBundle\Binary\BinaryInterface;
15			use Liip\ImagineBundle\Binary\Loader\LoaderInterface;
16			use Liip\ImagineBundle\Binary\MimeTypeGuesserInterface;
17			use Liip\ImagineBundle\Imagine\Filter\FilterConfiguration;
18			use Liip\ImagineBundle\Model\Binary;
19			use Symfony\Component\HttpFoundation\File\MimeType\ExtensionGuesserInterface as DeprecatedExtensionGuesserInterface;
20			use Symfony\Component\Mime\MimeTypesInterface;
21
22			class DataManager
23			{
24			/**
25			* @var MimeTypeGuesserInterface
26			*/
27			protected $mimeTypeGuesser;
28
29			/**
30			* @var DeprecatedExtensionGuesserInterface\|MimeTypesInterface
31			*/
32			protected $extensionGuesser;
33
34			/**
35			* @var FilterConfiguration
36			*/
37			protected $filterConfig;
38
39			/**
40			* @var string\|null
41			*/
42			protected $defaultLoader;
43
44			/**
45			* @var string\|null
46			*/
47			protected $globalDefaultImage;
48
49			/**
50			* @var LoaderInterface[]
51			*/
52			protected $loaders = [];
53
54			/**
55			* @param MimeTypeGuesserInterface $mimeTypeGuesser
56			* @param DeprecatedExtensionGuesserInterface\|MimeTypesInterface $extensionGuesser
57			* @param FilterConfiguration $filterConfig
58			* @param string $defaultLoader
59			* @param string $globalDefaultImage
60			*/
61			public function __construct(
62			MimeTypeGuesserInterface $mimeTypeGuesser,
63			$extensionGuesser,
64			FilterConfiguration $filterConfig,
65			$defaultLoader = null,
66			$globalDefaultImage = null
67			) {
68			if (interface_exists(MimeTypesInterface::class) && $extensionGuesser instanceof DeprecatedExtensionGuesserInterface) {
69			@trigger_error(sprintf('Passing a %s to "%s()" is deprecated since Symfony 4.3, pass a "%s" instead.', DeprecatedExtensionGuesserInterface::class, __METHOD__, MimeTypesInterface::class), E_USER_DEPRECATED);
			0 ignored issues – show Security Best Practice introduced 2019-08-27 21:30 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
70			}
71
72			$this->mimeTypeGuesser = $mimeTypeGuesser;
73			$this->filterConfig = $filterConfig;
74			$this->defaultLoader = $defaultLoader;
75			$this->extensionGuesser = $extensionGuesser;
76			$this->globalDefaultImage = $globalDefaultImage;
77			}
78
79			/**
80			* Adds a loader to retrieve images for the given filter.
81			*
82			* @param string $filter
83			* @param LoaderInterface $loader
84			*/
85			public function addLoader($filter, LoaderInterface $loader)
86			{
87			$this->loaders[$filter] = $loader;
88			}
89
90			/**
91			* Returns a loader previously attached to the given filter.
92			*
93			* @param string $filter
94			*
95			* @throws \InvalidArgumentException
96			*
97			* @return LoaderInterface
98			*/
99			public function getLoader($filter)
100			{
101			$config = $this->filterConfig->get($filter);
102
103			$loaderName = empty($config['data_loader']) ? $this->defaultLoader : $config['data_loader'];
104
105			if (!isset($this->loaders[$loaderName])) {
106			throw new \InvalidArgumentException(sprintf(
107			'Could not find data loader "%s" for "%s" filter type',
108			$loaderName,
109			$filter
110			));
111			}
112
113			return $this->loaders[$loaderName];
114			}
115
116			/**
117			* Retrieves an image with the given filter applied.
118			*
119			* @param string $filter
120			* @param string $path
121			*
122			* @throws \LogicException
123			*
124			* @return BinaryInterface
125			*/
126			public function find($filter, $path)
127			{
128			$loader = $this->getLoader($filter);
129
130			$binary = $loader->find($path);
131			if (!$binary instanceof BinaryInterface) {
132			$mimeType = $this->mimeTypeGuesser->guess($binary);
133
134			$extension = $this->getExtension($mimeType);
135			$binary = new Binary(
136			$binary,
137			$mimeType,
138			$extension
139			);
140			}
141
142			if (null === $binary->getMimeType()) {
143			throw new \LogicException(sprintf('The mime type of image %s was not guessed.', $path));
144			}
145
146			if (0 !== mb_strpos($binary->getMimeType(), 'image/')) {
147			throw new \LogicException(sprintf('The mime type of image %s must be image/xxx got %s.', $path, $binary->getMimeType()));
148			}
149
150			return $binary;
151			}
152
153			/**
154			* Get default image url with the given filter applied.
155			*
156			* @param string $filter
157			*
158			* @return string\|null
159			*/
160			public function getDefaultImageUrl($filter)
161			{
162			$config = $this->filterConfig->get($filter);
163
164			$defaultImage = null;
165			if (false === empty($config['default_image'])) {
166			$defaultImage = $config['default_image'];
167			} elseif (!empty($this->globalDefaultImage)) {
168			$defaultImage = $this->globalDefaultImage;
169			}
170
171			return $defaultImage;
172			}
173
174			private function getExtension(?string $mimeType): ?string
175			{
176			if ($this->extensionGuesser instanceof DeprecatedExtensionGuesserInterface) {
177			return $this->extensionGuesser->guess($mimeType);
178			}
179
180			if (null === $mimeType) {
181			return null;
182			}
183
184			return $this->extensionGuesser->getExtensions($mimeType)[0] ?? null;
185			}
186			}
187

liip / LiipImagineBundle

Pull Request — master (#1217)

DataManager::getDefaultImageUrl() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like