Pool::addDownloadStrategy() - Code Metrics - Inspection of "Merge 3.x into master (#1088)" - sonata-project/SonataMediaBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( fff6ad...32c587 )

by Christian

created 2016-07-23 07:59 UTC

Pool::addDownloadStrategy() A

↳ Parent: Pool

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	2

<?php

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\MediaBundle\Provider;

use Sonata\CoreBundle\Validator\ErrorElement;
use Sonata\MediaBundle\Model\MediaInterface;
use Sonata\MediaBundle\Security\DownloadStrategyInterface;

class Pool
{
    /**
     * @var array
     */
    protected $providers = array();

    /**
     * @var array
     */
    protected $contexts = array();

    /**
     * @deprecated Deprecated since version 3.1 and will be removed in 4.0. Use $downloadStrategies instead
     *
     * @var DownloadStrategyInterface[]
     */
    protected $downloadSecurities = array();

    /**
     * @var DownloadStrategyInterface[]
     */
    protected $downloadStrategies = array();

    /**
     * @var string
     */
    protected $defaultContext;

    /**
     * @param string $context
     */
    public function __construct($context)
    {
        $this->defaultContext = $context;
    }

    /**
     * @throws \RuntimeException
     *
     * @param string $name
     *
     * @return MediaProviderInterface
     */
    public function getProvider($name)
    {
        if (!$name) {
            throw new \InvalidArgumentException('Provider name cannot be empty, did you forget to call setProviderName() in your Media object?');
        }
        if (empty($this->providers)) {
            throw new \RuntimeException(sprintf('Unable to retrieve provider named "%s" since there are no providers configured yet.', $name));
        }
        if (!isset($this->providers[$name])) {
            throw new \InvalidArgumentException(sprintf('Unable to retrieve the provider named "%s". Available providers are %s.', $name, '"'.implode('", "', $this->getProviderList()).'"'));
        }

        return $this->providers[$name];
    }

    /**
     * @param string                 $name
     * @param MediaProviderInterface $instance
     */
    public function addProvider($name, MediaProviderInterface $instance)
    {
        $this->providers[$name] = $instance;
    }

    /**
     * @deprecated Deprecated since version 3.1, to be removed in 4.0
     *
     * @param string                    $name
     * @param DownloadStrategyInterface $security
     */
    public function addDownloadSecurity($name, DownloadStrategyInterface $security)
    {
        @trigger_error('The '.__METHOD__.' method is deprecated since version 3.1 and will be removed in 4.0.', 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->downloadSecurities[$name] = $security;


        $this->addDownloadStrategy($name, $security);
    }

    /**
     * @param string                    $name
     * @param DownloadStrategyInterface $security
     */
    public function addDownloadStrategy($name, DownloadStrategyInterface $security)
    {
        $this->downloadStrategies[$name] = $security;
    }

    /**
     * @param array $providers
     */
    public function setProviders($providers)
    {
        $this->providers = $providers;
    }

    /**
     * @return MediaProviderInterface[]
     */
    public function getProviders()
    {
        return $this->providers;
    }

    /**
     * @param string $name
     * @param array  $providers
     * @param array  $formats
     * @param array  $download
     */
    public function addContext($name, array $providers = array(), array $formats = array(), array $download = array())
    {
        if (!$this->hasContext($name)) {
            $this->contexts[$name] = array(
                'providers' => array(),
                'formats' => array(),
                'download' => array(),
            );
        }

        $this->contexts[$name]['providers'] = $providers;
        $this->contexts[$name]['formats'] = $formats;
        $this->contexts[$name]['download'] = $download;
    }

    /**
     * @param string $name
     *
     * @return bool
     */
    public function hasContext($name)
    {
        return isset($this->contexts[$name]);
    }

    /**
     * @param string $name
     *
     * @return array|null
     */
    public function getContext($name)
    {
        if (!$this->hasContext($name)) {
            return;
        }

        return $this->contexts[$name];
    }

    /**
     * Returns the context list.
     *
     * @return array
     */
    public function getContexts()
    {
        return $this->contexts;
    }

    /**
     * @param string $name
     *
     * @return array
     */
    public function getProviderNamesByContext($name)
    {
        $context = $this->getContext($name);

        if (!$context) {
            return;
        }

        return $context['providers'];
    }

    /**
     * @param string $name
     *
     * @return array
     */
    public function getFormatNamesByContext($name)
    {
        $context = $this->getContext($name);

        if (!$context) {
            return;
        }

        return $context['formats'];
    }

    /**
     * @param string $name
     *
     * @return array
     */
    public function getProvidersByContext($name)
    {
        $providers = array();

        if (!$this->hasContext($name)) {
            return $providers;
        }

        foreach ($this->getProviderNamesByContext($name) as $name) {
            $providers[] = $this->getProvider($name);
        }

        return $providers;
    }

    /**
     * @return array
     */
    public function getProviderList()
    {
        $choices = array();
        foreach (array_keys($this->providers) as $name) {
            $choices[$name] = $name;
        }

        return $choices;
    }

    /**
     * @deprecated Deprecated since version 3.1, to be removed in 4.0
     *
     * @param MediaInterface $media
     *
     * @return DownloadStrategyInterface
     *
     * @throws \RuntimeException
     */
    public function getDownloadSecurity(MediaInterface $media)
    {
        @trigger_error('The '.__METHOD__.' method is deprecated since version 3.1 and will be removed in 4.0.', 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.');
}

        return array_merge($this->getDownloadSecurity($media), $this->getDownloadStrategy($media));

    }

    /**
     * @param MediaInterface $media
     *
     * @return DownloadStrategyInterface
     *
     * @throws \RuntimeException
     */
    public function getDownloadStrategy(MediaInterface $media)
    {
        $context = $this->getContext($media->getContext());

        $id = $context['download']['strategy'];

        // NEXT_MAJOR: remove this line with the next major release.
        if (isset($this->downloadSecurities[$id])) {

            return $this->downloadSecurities[$id];

        }

        if (!isset($this->downloadStrategies[$id])) {
            throw new \RuntimeException('Unable to retrieve the download security : '.$id);
        }

        return $this->downloadStrategies[$id];
    }

    /**
     * @param MediaInterface $media
     *
     * @return string
     */
    public function getDownloadMode(MediaInterface $media)
    {
        $context = $this->getContext($media->getContext());

        return $context['download']['mode'];
    }

    /**
     * @return string
     */
    public function getDefaultContext()
    {
        return $this->defaultContext;
    }

    /**
     * @param ErrorElement   $errorElement
     * @param MediaInterface $media
     */
    public function validate(ErrorElement $errorElement, MediaInterface $media)
    {
        if (!$media->getProviderName()) {
            return;
        }

        $provider = $this->getProvider($media->getProviderName());

        $provider->validate($errorElement, $media);
    }
}


1			<?php
2
3			/*
4			* This file is part of the Sonata Project package.
5			*
6			* (c) Thomas Rabaix <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Sonata\MediaBundle\Provider;
13
14			use Sonata\CoreBundle\Validator\ErrorElement;
15			use Sonata\MediaBundle\Model\MediaInterface;
16			use Sonata\MediaBundle\Security\DownloadStrategyInterface;
17
18			class Pool
19			{
20			/**
21			* @var array
22			*/
23			protected $providers = array();
24
25			/**
26			* @var array
27			*/
28			protected $contexts = array();
29
30			/**
31			* @deprecated Deprecated since version 3.1 and will be removed in 4.0. Use $downloadStrategies instead
32			*
33			* @var DownloadStrategyInterface[]
34			*/
35			protected $downloadSecurities = array();
36
37			/**
38			* @var DownloadStrategyInterface[]
39			*/
40			protected $downloadStrategies = array();
41
42			/**
43			* @var string
44			*/
45			protected $defaultContext;
46
47			/**
48			* @param string $context
49			*/
50			public function __construct($context)
51			{
52			$this->defaultContext = $context;
53			}
54
55			/**
56			* @throws \RuntimeException
57			*
58			* @param string $name
59			*
60			* @return MediaProviderInterface
61			*/
62			public function getProvider($name)
63			{
64			if (!$name) {
65			throw new \InvalidArgumentException('Provider name cannot be empty, did you forget to call setProviderName() in your Media object?');
66			}
67			if (empty($this->providers)) {
68			throw new \RuntimeException(sprintf('Unable to retrieve provider named "%s" since there are no providers configured yet.', $name));
69			}
70			if (!isset($this->providers[$name])) {
71			throw new \InvalidArgumentException(sprintf('Unable to retrieve the provider named "%s". Available providers are %s.', $name, '"'.implode('", "', $this->getProviderList()).'"'));
72			}
73
74			return $this->providers[$name];
75			}
76
77			/**
78			* @param string $name
79			* @param MediaProviderInterface $instance
80			*/
81			public function addProvider($name, MediaProviderInterface $instance)
82			{
83			$this->providers[$name] = $instance;
84			}
85
86			/**
87			* @deprecated Deprecated since version 3.1, to be removed in 4.0
88			*
89			* @param string $name
90			* @param DownloadStrategyInterface $security
91			*/
92			public function addDownloadSecurity($name, DownloadStrategyInterface $security)
93			{
94			@trigger_error('The '.__METHOD__.' method is deprecated since version 3.1 and will be removed in 4.0.', E_USER_DEPRECATED);
			0 ignored issues – show Security Best Practice introduced 2016-01-21 04:54 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...
95
96			$this->downloadSecurities[$name] = $security;
			0 ignored issues – show Deprecated Code introduced 2016-07-23 07:41 UTC by Report Bug Copy Issue Report The property `Sonata\MediaBundle\Provi...ol::$downloadSecurities` has been deprecated with message: Deprecated since version 3.1 and will be removed in 4.0. Use $downloadStrategies instead This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
97
98			$this->addDownloadStrategy($name, $security);
99			}
100
101			/**
102			* @param string $name
103			* @param DownloadStrategyInterface $security
104			*/
105			public function addDownloadStrategy($name, DownloadStrategyInterface $security)
106			{
107			$this->downloadStrategies[$name] = $security;
108			}
109
110			/**
111			* @param array $providers
112			*/
113			public function setProviders($providers)
114			{
115			$this->providers = $providers;
116			}
117
118			/**
119			* @return MediaProviderInterface[]
120			*/
121			public function getProviders()
122			{
123			return $this->providers;
124			}
125
126			/**
127			* @param string $name
128			* @param array $providers
129			* @param array $formats
130			* @param array $download
131			*/
132			public function addContext($name, array $providers = array(), array $formats = array(), array $download = array())
133			{
134			if (!$this->hasContext($name)) {
135			$this->contexts[$name] = array(
136			'providers' => array(),
137			'formats' => array(),
138			'download' => array(),
139			);
140			}
141
142			$this->contexts[$name]['providers'] = $providers;
143			$this->contexts[$name]['formats'] = $formats;
144			$this->contexts[$name]['download'] = $download;
145			}
146
147			/**
148			* @param string $name
149			*
150			* @return bool
151			*/
152			public function hasContext($name)
153			{
154			return isset($this->contexts[$name]);
155			}
156
157			/**
158			* @param string $name
159			*
160			* @return array\|null
161			*/
162			public function getContext($name)
163			{
164			if (!$this->hasContext($name)) {
165			return;
166			}
167
168			return $this->contexts[$name];
169			}
170
171			/**
172			* Returns the context list.
173			*
174			* @return array
175			*/
176			public function getContexts()
177			{
178			return $this->contexts;
179			}
180
181			/**
182			* @param string $name
183			*
184			* @return array
185			*/
186			public function getProviderNamesByContext($name)
187			{
188			$context = $this->getContext($name);
189
190			if (!$context) {
191			return;
192			}
193
194			return $context['providers'];
195			}
196
197			/**
198			* @param string $name
199			*
200			* @return array
201			*/
202			public function getFormatNamesByContext($name)
203			{
204			$context = $this->getContext($name);
205
206			if (!$context) {
207			return;
208			}
209
210			return $context['formats'];
211			}
212
213			/**
214			* @param string $name
215			*
216			* @return array
217			*/
218			public function getProvidersByContext($name)
219			{
220			$providers = array();
221
222			if (!$this->hasContext($name)) {
223			return $providers;
224			}
225
226			foreach ($this->getProviderNamesByContext($name) as $name) {
227			$providers[] = $this->getProvider($name);
228			}
229
230			return $providers;
231			}
232
233			/**
234			* @return array
235			*/
236			public function getProviderList()
237			{
238			$choices = array();
239			foreach (array_keys($this->providers) as $name) {
240			$choices[$name] = $name;
241			}
242
243			return $choices;
244			}
245
246			/**
247			* @deprecated Deprecated since version 3.1, to be removed in 4.0
248			*
249			* @param MediaInterface $media
250			*
251			* @return DownloadStrategyInterface
252			*
253			* @throws \RuntimeException
254			*/
255			public function getDownloadSecurity(MediaInterface $media)
256			{
257			@trigger_error('The '.__METHOD__.' method is deprecated since version 3.1 and will be removed in 4.0.', E_USER_DEPRECATED);
			0 ignored issues – show Security Best Practice introduced 2016-01-21 04:54 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...
258
259			return array_merge($this->getDownloadSecurity($media), $this->getDownloadStrategy($media));
			0 ignored issues – show Deprecated Code introduced 2016-07-23 07:41 UTC by Report Bug Copy Issue Report The method `Sonata\MediaBundle\Provi...::getDownloadSecurity()` has been deprecated with message: Deprecated since version 3.1, to be removed in 4.0 This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
260			}
261
262			/**
263			* @param MediaInterface $media
264			*
265			* @return DownloadStrategyInterface
266			*
267			* @throws \RuntimeException
268			*/
269			public function getDownloadStrategy(MediaInterface $media)
270			{
271			$context = $this->getContext($media->getContext());
272
273			$id = $context['download']['strategy'];
274
275			// NEXT_MAJOR: remove this line with the next major release.
276			if (isset($this->downloadSecurities[$id])) {
			0 ignored issues – show Deprecated Code introduced 2016-07-23 07:41 UTC by Report Bug Copy Issue Report The property `Sonata\MediaBundle\Provi...ol::$downloadSecurities` has been deprecated with message: Deprecated since version 3.1 and will be removed in 4.0. Use $downloadStrategies instead This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
277			return $this->downloadSecurities[$id];
			0 ignored issues – show Deprecated Code introduced 2016-07-23 07:41 UTC by Report Bug Copy Issue Report The property `Sonata\MediaBundle\Provi...ol::$downloadSecurities` has been deprecated with message: Deprecated since version 3.1 and will be removed in 4.0. Use $downloadStrategies instead This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
278			}
279
280			if (!isset($this->downloadStrategies[$id])) {
281			throw new \RuntimeException('Unable to retrieve the download security : '.$id);
282			}
283
284			return $this->downloadStrategies[$id];
285			}
286
287			/**
288			* @param MediaInterface $media
289			*
290			* @return string
291			*/
292			public function getDownloadMode(MediaInterface $media)
293			{
294			$context = $this->getContext($media->getContext());
295
296			return $context['download']['mode'];
297			}
298
299			/**
300			* @return string
301			*/
302			public function getDefaultContext()
303			{
304			return $this->defaultContext;
305			}
306
307			/**
308			* @param ErrorElement $errorElement
309			* @param MediaInterface $media
310			*/
311			public function validate(ErrorElement $errorElement, MediaInterface $media)
312			{
313			if (!$media->getProviderName()) {
314			return;
315			}
316
317			$provider = $this->getProvider($media->getProviderName());
318
319			$provider->validate($errorElement, $media);
320			}
321			}
322

sonata-project / SonataMediaBundle

Push — master ( fff6ad...32c587 )

Pool::addDownloadStrategy() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like