SaturateTrait::iocContainer() - Code Metrics - spiral/common - Measure and Improve Code Quality continuously with Scrutinizer

SaturateTrait::iocContainer()
last analyzed 2020-03-12 14:40 UTC

↳ Parent: SaturateTrait

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
nc	1
dl	0
loc	1
ccs	0
cts	0
cp	0
c	0
b	0
f	0

<?php
/**
 * Spiral Framework.
 *
 * @license   MIT
 * @author    Anton Titov (Wolfy-J)
 */

namespace Spiral\Core\Traits;

use Interop\Container\ContainerInterface;
use Interop\Container\Exception\ContainerException;
use Spiral\Core\Exceptions\ScopeException;

/**
 * Saturate optional constructor or method argument (class) using internal (usually static)
 * container. In most of cases trait is doing nothing since spiral Container populates even
 * optional class dependencies.
 *
 * Avoid using this trait in custom code, it's only a development sugar.
 */
trait SaturateTrait
{
    /**
     * Must be used only to resolve optional constructor arguments. Use in classes which are
     * generally resolved using Container. Default value MUST always be supplied from outside.
     *
     * @param mixed  $default Default value.
     * @param string $class   Requested class.
     *
     * @return mixed|null|object
     *
     * @throws ScopeException
     */
    private function saturate($default, $class)

    {
        if (!empty($default)) {
            return $default;
        }

        $container = $this->iocContainer();

        if (empty($container)) {
            throw new ScopeException("Unable to saturate '{$class}': no container available");
        }

        //Only when global container is set
        try {
            return $container->get($class);
        } catch (ContainerException $e) {
            throw new ScopeException("Unable to saturate '{$class}': {$e->getMessage()}", 0, $e);
        }
    }

    /**
     * Class specific container.
     *
     * @return ContainerInterface
     */
    abstract protected function iocContainer();
}


1		<?php
2		/**
3		* Spiral Framework.
4		*
5		* @license MIT
6		* @author Anton Titov (Wolfy-J)
7		*/
8
9		namespace Spiral\Core\Traits;
10
11		use Interop\Container\ContainerInterface;
12		use Interop\Container\Exception\ContainerException;
13		use Spiral\Core\Exceptions\ScopeException;
14
15		/**
16		* Saturate optional constructor or method argument (class) using internal (usually static)
17		* container. In most of cases trait is doing nothing since spiral Container populates even
18		* optional class dependencies.
19		*
20		* Avoid using this trait in custom code, it's only a development sugar.
21		*/
22		trait SaturateTrait
23		{
24		/**
25		* Must be used only to resolve optional constructor arguments. Use in classes which are
26		* generally resolved using Container. Default value MUST always be supplied from outside.
27		*
28		* @param mixed $default Default value.
29		* @param string $class Requested class.
30		*
31		* @return mixed\|null\|object
32		*
33		* @throws ScopeException
34		*/
35	5	private function saturate($default, $class)
		0 ignored issues – show Unused Code introduced 2018-06-03 17:30 UTC by Report Bug Copy Issue Report This method is not used, and could be removed. Loading history...
36		{
37	5	if (!empty($default)) {
38	2	return $default;
39		}
40
41	3	$container = $this->iocContainer();
42
43	3	if (empty($container)) {
44	1	throw new ScopeException("Unable to saturate '{$class}': no container available");
45		}
46
47		//Only when global container is set
48		try {
49	2	return $container->get($class);
50	1	} catch (ContainerException $e) {
51	1	throw new ScopeException("Unable to saturate '{$class}': {$e->getMessage()}", 0, $e);
52		}
53		}
54
55		/**
56		* Class specific container.
57		*
58		* @return ContainerInterface
59		*/
60		abstract protected function iocContainer();
61		}
62

spiral / common

SaturateTrait::iocContainer() last analyzed 2020-03-12 14:40 UTC

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

SaturateTrait::iocContainer()
last analyzed 2020-03-12 14:40 UTC