samsonframework\di\Container

Complexity

Total Complexity

23

Size/Duplication

Total Lines	179
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

Test Coverage

Coverage

90.91%

Importance

Changes	44
Bugs	2	Features	19

9 Methods

Rating	Name	Duplication	Size	Complexity
A	logic()	0	8	2
A	get()	0	11	2
A	getFromDelegate()	0	15	4
A	delegate()	0	4	1
A	has()	0	8	3
A	hasDelegate()	0	10	3
A	service()	0	6	1
A	set()	0	15	2
B	getServices()	0	14	5

<?php declare(strict_types=1);
/**
 * Created by Vitaly Iegorov <egorov@samsonos.com>.
 * on 26.01.16 at 15:11
 */
namespace samsonframework\di;

use samsonframework\container\ContainerInterface;
use samsonframework\di\exception\ClassNotFoundException;
use samsonframework\di\exception\ContainerException;

/**
 * Dependency container.
 *
 * @author Vitaly Iegorov <egorov@samsonos.com>
 */
class Container implements ContainerInterface
{
    /** @var array Collection of instantiated service instances */
    protected $serviceInstances = [];

    /** @var array[string] Collection of loaded services */
    protected $services = [];

    /** @var array[string] Collection of alias => class name for alias resolving */
    protected $aliases = [];

    /** @var array[string] Collection of class name dependencies trees */
    protected $dependencies = [];

    /** @var ContainerInterface[] Collection of delegated containers */
    protected $delegates = [];

    /** @var callable Dependency resolving function callable */
    protected $logicCallable;

    /** @var array Collection of scope => [alias => class_name] */
    protected $scopes = [];

    /**
     * Wrapper for calling dependency resolving function.
     *
     * @param string $dependency Dependency name
     *
     * @return mixed Created instance or null
     * @throws ContainerException
     */
    protected function logic($dependency)
    {
        if (!is_callable($this->logicCallable)) {
            throw new ContainerException('Logic function is not callable');
        }

        return call_user_func($this->logicCallable, $dependency);
    }

    /**
     * {@inheritdoc}
     *
     * @throws \samsonframework\di\exception\ContainerException
     * @throws \samsonframework\di\exception\ClassNotFoundException
     */
    public function get($dependency)
    {
        // Get pointer from logic
        $module = $this->logic($dependency) ?? $this->getFromDelegate($dependency);

        if (null === $module) {
            throw new ClassNotFoundException($dependency);
        } else {
            return $module;
        }
    }

    /**
     * Try to find dependency in delegate container.
     *
     * @param string $dependency Dependency identifier
     *
     * @return mixed Delegate found dependency
     *
     * @throws \Interop\Container\Exception\ContainerException
     */
    protected function getFromDelegate(string $dependency)
    {
        // Try delegate lookup
        foreach ($this->delegates as $delegate) {
            try {
                return $delegate->get($dependency);
            } catch (ContainerException $e) {
                // Catch all delegated exceptions
            } catch (ClassNotFoundException $e) {
                // Catch all delegated exceptions
            }
        }

        return null;
    }

    /**
     * Implementing delegate lookup feature.
     * If current container cannot resolve entity dependency
     * resolving process is passed to delegated container.
     *
     * @param ContainerInterface $container Container for delegate lookup
     */
    public function delegate(ContainerInterface $container)
    {
        $this->delegates[] = $container;
    }

    /**
     * {@inheritdoc}
     */
    public function has($dependency) : bool
    {
        $found = array_key_exists($dependency, $this->dependencies)
            || in_array($dependency, $this->aliases, true);

        // Return true if found or try delegate containers
        return $found ?: $this->hasDelegate($dependency);
    }

    /**
     * Define if delegate containers have dependency.
     *
     * @param string $dependency Dependency identifier
     *
     * @return bool True if delegate containers have dependency
     */
    protected function hasDelegate(string $dependency) : bool
    {
        foreach ($this->delegates as $delegate) {
            if ($delegate->has($dependency)) {
                return true;
            }
        }

        return false;
    }

    /**
     * Set service dependency. Upon first creation of this class instance
     * it would be used everywhere where this dependency is needed.
     *
     * @param string $className  Fully qualified class name
     * @param array  $parameters Collection of parameters needed for dependency creation
     * @param string $alias      Dependency name
     *
     * @return ContainerInterface Chaining
     */
    public function service($className, array $parameters = [], string $alias = null) : ContainerInterface
    {
        $this->services[$className] = $className;

        return $this->set($className, $parameters, $alias);
    }

    /**
     * {@inheritdoc}
     */
    public function set($className, array $dependencies = [], string $alias = null) : ContainerInterface
    {
        // Create dependencies collection for class name
        if (!array_key_exists($className, $this->dependencies)) {
            $this->dependencies[$className] = [];
        }
        
        // Merge other class constructor parameters
        $this->dependencies[$className] = array_merge($this->dependencies[$className], $dependencies);

        // Store alias for this class name
        $this->aliases[$className] = $alias;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getServices(string $filterScope = null) : array
    {
        $filtered = [];
        if ($filterScope !== null && array_key_exists($filterScope, $this->scopes)) {
            foreach ($this->scopes[$filterScope] as $alias => $className) {
                if (array_key_exists($alias, $this->serviceInstances)) {
                    $filtered[$alias] = $this->serviceInstances[$alias];
                }
            }
            return $filtered;
        } else {
            return $this->serviceInstances;
        }
    }
}