codeburnerframework / container

src/Container.php

Indentation +419 added lines, -419 removed lines

@@ -30,424 +30,424 @@
 class Container implements ContainerInterface
 {
 
-    /**
-     * Holds all resolved or resolvable instances into the container.
-     *
-     * @var array
-     */
-
-    protected $collection;
-
-    /**
-     * Class specific defined dependencies.
-     *
-     * @var array
-     */
-
-    protected $dependencies;
-
-    /**
-     * Cache of classes inspector and resolver.
-     *
-     * @var array
-     */
-
-    protected $resolving;
-
-    /**
-     * Cache of classes dependencies in callbacks ready for resolution.
-     *
-     * @var array
-     */
-
-    protected $resolved;
-
-    /**
-     * Call a user function injecting the dependencies.
-     *
-     * @param string|Closure $function   The function or the user function name.
-     * @param array          $parameters The predefined dependencies.
-     *
-     * @return mixed
-     */
-
-    public function call($function, array $parameters = [])
-    {
-        $inspector = new ReflectionFunction($function);
-        $dependencies = $inspector->getParameters();
-        $resolvedClosureDependencies = [];
-
-        foreach ($dependencies as $dependency) {
-            if (isset($parameters[$dependency->name])) {
-                $resolvedClosureDependencies[] = $parameters[$dependency->name];
-            } else {
-                if (($class = $dependency->getClass()) === null) {
-                       $resolvedClosureDependencies[] = $dependency->getDefaultValue();
-                } else $resolvedClosureDependencies[] = $this->make($class->name);
-            }
-        }
-
-        return call_user_func_array($function, $resolvedClosureDependencies);
-    }
-
-    /**
-     * Makes an element or class injecting automatically all the dependencies.
-     *
-     * @param string $abstract   The class name or container element name to make.
-     * @param array  $parameters Specific parameters definition.
-     * @param bool   $force      Specify if a new element must be given and the dependencies must have be recalculated.
-     *
-     * @throws \Psr\Container\Exception\ContainerException
-     * @return object|null
-     */
-
-    public function make(string $abstract, array $parameters = [], bool $force = false)
-    {
-        if ($force === false && isset($this->collection[$abstract])) {
-            return $this->get($abstract);
-        }
-
-        if (isset($this->resolving[$abstract])) {
-            return $this->resolving[$abstract]($abstract, $parameters);
-        }
-
-        return ($this->resolving[$abstract] = $this->construct($abstract, $force))($abstract, $parameters);
-    }
-
-    /**
-     * Construct a class and all the dependencies using the reflection library of PHP.
-     *
-     * @param string $abstract The class name or container element name to make.
-     * @param bool   $force    Specify if a new element must be given and the dependencies must have be recalculated.
-     *
-     * @throws ReflectionException
-     * @return Closure
-     */
-
-    protected function construct(string $abstract, bool $force) : Closure
-    {
-        $inspector = new ReflectionClass($abstract);
-
-        if ($constructor  = $inspector->getConstructor()) {
-            $dependencies = $constructor->getParameters();
-
-            return function (string $abstract, array $parameters) use ($inspector, $dependencies, $force) {
-                $resolvedClassParameters = [];
-
-                foreach ($dependencies as $dependency) {
-                    if (isset($parameters[$dependency->name])) {
-                           $resolvedClassParameters[] = $parameters[$dependency->name];
-                    } else $resolvedClassParameters[] = $this->resolve($abstract, $dependency, $force);
-                }
-
-                return $inspector->newInstanceArgs($resolvedClassParameters);
-            };
-        }
-
-        return function (string $abstract) {
-            return new $abstract;
-        };
-    }
-
-    /**
-     * Resolve all the given class reflected dependencies.
-     *
-     * @param string               $abstract   The class name or container element name to resolve dependencies.
-     * @param ReflectionParameter  $dependency The class dependency to be resolved.
-     * @param bool                 $force      Specify if the dependencies must be recalculated.
-     *
-     * @return Object
-     */
-
-    protected function resolve(string $abstract, ReflectionParameter $dependency, bool $force)
-    {
-        $key = $abstract.$dependency->name;
-
-        if (! isset($this->resolved[$key]) || $force === true) {
-            $this->resolved[$key] = $this->generate($abstract, $dependency);
-        }
-
-        return $this->resolved[$key]($this);
-    }
-
-    /**
-     * Generate the dependencies callbacks to jump some conditions in every dependency creation.
-     *
-     * @param string               $abstract   The class name or container element name to resolve dependencies.
-     * @param ReflectionParameter  $dependency The class dependency to be resolved.
-     *
-     * @return Closure
-     */
-
-    protected function generate(string $abstract, ReflectionParameter $dependency) : Closure
-    {
-        if ($class = $dependency->getClass()) {
-            $classname = $class->name;
-            $key = $abstract.$classname;
-
-            if (isset($this->dependencies[$key])) {
-                return $this->dependencies[$key];
-            }
-
-            return function () use ($classname) {
-                return $this->make($classname);
-            };
-        }
-
-        return $class->getDefaultValue();
-    }
-
-    /**
-     * Reset the container, removing all the elements, cache and options.
-     *
-     * @return self
-     */
-
-    public function flush() : self
-    {
-        $this->collection = [];
-        $this->dependencies = [];
-        $this->resolving = [];
-        $this->resolved = [];
-
-        return $this;
-    }
-
-    /**
-     * Finds an entry of the container by its identifier and returns it.
-     *
-     * @param string $abstract Identifier of the entry to look for.
-     *
-     * @throws \Psr\Container\Exception\NotFoundException  No entry was found for this identifier.
-     * @throws \Psr\Container\Exception\ContainerException Error while retrieving the entry.
-     *
-     * @return mixed Entry.
-     */
-    public function get($abstract)
-    {
-        if (! isset($this->collection[$abstract])) {
-            throw new NotFoundException("Element '$abstract' not found");
-        }
-
-        if ($this->collection[$abstract] instanceof Closure) {
-            try {
-                return $this->collection[$abstract]($this);
-            } catch (Exception $e) {
-                throw new ContainerException("An exception was thrown while attempt to make $abstract", 0, $e);
-            }
-        }
-
-        return $this->collection[$abstract];
-    }
-
-    /**
-     * Returns true if the container can return an entry for the given identifier.
-     * Returns false otherwise.
-     *
-     * `has($abstract)` returning true does not mean that `get($abstract)` will not throw an exception.
-     * It does however mean that `get($abstract)` will not throw a `NotFoundException`.
-     *
-     * @param string $abstract Identifier of the entry to look for.
-     *
-     * @return boolean
-     */
-
-    public function has($abstract)
-    {
-        return isset($this->collection[$abstract]);
-    }
-
-    /**
-     * Verify if an element has a singleton instance.
-     *
-     * @param  string The class name or container element name to resolve dependencies.
-     * @return bool
-     */
-
-    public function isSingleton(string $abstract) : bool
-    {
-        return isset($this->collection[$abstract]) && $this->collection[$abstract] instanceof Closure === false;
-    }
-
-    /**
-     * Verify if an element is a instance of something.
-     *
-     * @param  string The class name or container element name to resolve dependencies.
-     * @return bool
-     */
-    public function isInstance(string $abstract) : bool
-    {
-        return isset($this->collection[$abstract]) && is_object($this->collection[$abstract]);
-    }
-
-    /**
-     * Bind a new element to the container.
-     *
-     * @param string                $abstract The alias name that will be used to call the element.
-     * @param string|closure|object $concrete The element class name, or an closure that makes the element, or the object itself.
-     * @param bool                  $shared   Define if the element will be a singleton instance.
-     *
-     * @return \Codeburner\Container\Container
-     */
-
-    public function set(string $abstract, $concrete, bool $shared = false) : self
-    {
-        if (is_object($concrete)) {
-            return $this->instance($abstract, $concrete);
-        }
-
-        if ($concrete instanceof Closure === false) {
-            $concrete = function (Container $container) use ($concrete) {
-                return $container->make($concrete);
-            };
-        }
-
-        if ($shared === true) {
-               $this->collection[$abstract] = $concrete($this);
-        } else $this->collection[$abstract] = $concrete;
-
-        return $this;
-    }
-
-    /**
-     * Bind a new element to the container IF the element name not exists in the container.
-     *
-     * @param string         $abstract The alias name that will be used to call the element.
-     * @param string|closure $concrete The element class name, or an closure that makes the element.
-     * @param bool           $shared   Define if the element will be a singleton instance.
-     *
-     * @return \Codeburner\Container\Container
-     */
-
-    public function setIf(string $abstract, $concrete, bool $shared = false) : self
-    {
-        if (! isset($this->collection[$abstract])) {
-            $this->set($abstract, $concrete, $shared);
-        }
-
-        return $this;
-    }
-
-    /**
-     * Bind an specific instance to a class dependency.
-     *
-     * @param string         $class          The class full name.
-     * @param string         $dependencyName The dependency full name.
-     * @param string|closure $dependency     The specific object class name or a classure that makes the element.
-     *
-     * @return \Codeburner\Container\Container
-     */
-
-    public function setTo(string $class, string $dependencyName, $dependency) : self
-    {
-        if ($dependency instanceof Closure === false) {
-            if (is_object($dependency)) {
-                $dependency = function () use ($dependency) {
-                    return $dependency;
-                };
-            } else {
-                $dependency = function () use ($dependency) {
-                    return $this->get($dependency);
-                };
-            }
-        }
-
-        $this->dependencies[$class.$dependencyName] = $dependency;
-
-        return $this;
-    }
-
-    /**
-     * Bind an element that will be construct only one time, and every call for the element,
-     * the same instance will be given.
-     *
-     * @param string         $abstract The alias name that will be used to call the element.
-     * @param string|closure $concrete The element class name, or an closure that makes the element.
-     *
-     * @return \Codeburner\Container\Container
-     */
-
-    public function singleton(string $abstract, $concrete) : self
-    {
-        $this->set($abstract, $concrete, true);
-
-        return $this;
-    }
-
-    /**
-     * Bind an object to the container.
-     *
-     * @param string $abstract The alias name that will be used to call the object.
-     * @param object $instance The object that will be inserted.
-     *
-     * @throws \Psr\Container\Exception\ContainerException When $instance is not an object.
-     * @return \Codeburner\Container\Container
-     */
-
-    public function instance(string $abstract, $instance) : self
-    {
-        if (! is_object($instance)) {
-            throw new ContainerException('Trying to store ' . gettype($type) . ' as object.');
-        }
-
-        $this->collection[$abstract] = $instance;
-
-        return $this;
-    }
-
-    /**
-     * Modify an element with a given function that receive the old element as argument.
-     *
-     * @param string  $abstract  The alias name that will be used to call the element.
-     * @param closure $extension The function that receives the old element and return a new or modified one.
-     *
-     * @throws \Psr\Container\Exception\NotFoundException  When no element was found with $abstract key.
-     * @return \Codeburner\Container\Container
-     */
-
-    public function extend(string $abstract, closure $extension) : self
-    {
-        if (! isset($this->collection[$abstract])) {
-            throw new NotFoundException;
-        }
-
-        $object = $this->collection[$abstract];
-
-        if ($object instanceof Closure) {
-            $this->collection[$abstract] = function () use ($object, $extension) {
-                return $extension($object($this), $this);
-            };
-        } else {
-            $this->collection[$abstract] = $extension($object, $this);
-        }
-
-        return $this;
-    }
-
-    /**
-     * Makes an resolvable element an singleton.
-     *
-     * @param  string $abstract The alias name that will be used to call the element.
-     *
-     * @throws \Psr\Container\Exception\NotFoundException  When no element was found with $abstract key.
-     * @throws \Psr\Container\Exception\ContainerException When the element on $abstract key is not resolvable.
-     *
-     * @return \Codeburner\Container\Container
-     */
-
-    public function share(string $abstract) : self
-    {
-        if (! isset($this->collection[$abstract])) {
-            throw new NotFoundException("Element '$abstract' not found");
-        }
-
-        if (! $this->collection[$abstract] instanceof Closure) {
-            throw new ContainerException("'$abstract' must be a resolvable element");
-        }
-
-        $this->collection[$abstract] = $this->collection[$abstract]($this);
-
-        return $this;
-    }
+	/**
+	 * Holds all resolved or resolvable instances into the container.
+	 *
+	 * @var array
+	 */
+
+	protected $collection;
+
+	/**
+	 * Class specific defined dependencies.
+	 *
+	 * @var array
+	 */
+
+	protected $dependencies;
+
+	/**
+	 * Cache of classes inspector and resolver.
+	 *
+	 * @var array
+	 */
+
+	protected $resolving;
+
+	/**
+	 * Cache of classes dependencies in callbacks ready for resolution.
+	 *
+	 * @var array
+	 */
+
+	protected $resolved;
+
+	/**
+	 * Call a user function injecting the dependencies.
+	 *
+	 * @param string|Closure $function   The function or the user function name.
+	 * @param array          $parameters The predefined dependencies.
+	 *
+	 * @return mixed
+	 */
+
+	public function call($function, array $parameters = [])
+	{
+		$inspector = new ReflectionFunction($function);
+		$dependencies = $inspector->getParameters();
+		$resolvedClosureDependencies = [];
+
+		foreach ($dependencies as $dependency) {
+			if (isset($parameters[$dependency->name])) {
+				$resolvedClosureDependencies[] = $parameters[$dependency->name];
+			} else {
+				if (($class = $dependency->getClass()) === null) {
+					   $resolvedClosureDependencies[] = $dependency->getDefaultValue();
+				} else $resolvedClosureDependencies[] = $this->make($class->name);
+			}
+		}
+
+		return call_user_func_array($function, $resolvedClosureDependencies);
+	}
+
+	/**
+	 * Makes an element or class injecting automatically all the dependencies.
+	 *
+	 * @param string $abstract   The class name or container element name to make.
+	 * @param array  $parameters Specific parameters definition.
+	 * @param bool   $force      Specify if a new element must be given and the dependencies must have be recalculated.
+	 *
+	 * @throws \Psr\Container\Exception\ContainerException
+	 * @return object|null
+	 */
+
+	public function make(string $abstract, array $parameters = [], bool $force = false)
+	{
+		if ($force === false && isset($this->collection[$abstract])) {
+			return $this->get($abstract);
+		}
+
+		if (isset($this->resolving[$abstract])) {
+			return $this->resolving[$abstract]($abstract, $parameters);
+		}
+
+		return ($this->resolving[$abstract] = $this->construct($abstract, $force))($abstract, $parameters);
+	}
+
+	/**
+	 * Construct a class and all the dependencies using the reflection library of PHP.
+	 *
+	 * @param string $abstract The class name or container element name to make.
+	 * @param bool   $force    Specify if a new element must be given and the dependencies must have be recalculated.
+	 *
+	 * @throws ReflectionException
+	 * @return Closure
+	 */
+
+	protected function construct(string $abstract, bool $force) : Closure
+	{
+		$inspector = new ReflectionClass($abstract);
+
+		if ($constructor  = $inspector->getConstructor()) {
+			$dependencies = $constructor->getParameters();
+
+			return function (string $abstract, array $parameters) use ($inspector, $dependencies, $force) {
+				$resolvedClassParameters = [];
+
+				foreach ($dependencies as $dependency) {
+					if (isset($parameters[$dependency->name])) {
+						   $resolvedClassParameters[] = $parameters[$dependency->name];
+					} else $resolvedClassParameters[] = $this->resolve($abstract, $dependency, $force);
+				}
+
+				return $inspector->newInstanceArgs($resolvedClassParameters);
+			};
+		}
+
+		return function (string $abstract) {
+			return new $abstract;
+		};
+	}
+
+	/**
+	 * Resolve all the given class reflected dependencies.
+	 *
+	 * @param string               $abstract   The class name or container element name to resolve dependencies.
+	 * @param ReflectionParameter  $dependency The class dependency to be resolved.
+	 * @param bool                 $force      Specify if the dependencies must be recalculated.
+	 *
+	 * @return Object
+	 */
+
+	protected function resolve(string $abstract, ReflectionParameter $dependency, bool $force)
+	{
+		$key = $abstract.$dependency->name;
+
+		if (! isset($this->resolved[$key]) || $force === true) {
+			$this->resolved[$key] = $this->generate($abstract, $dependency);
+		}
+
+		return $this->resolved[$key]($this);
+	}
+
+	/**
+	 * Generate the dependencies callbacks to jump some conditions in every dependency creation.
+	 *
+	 * @param string               $abstract   The class name or container element name to resolve dependencies.
+	 * @param ReflectionParameter  $dependency The class dependency to be resolved.
+	 *
+	 * @return Closure
+	 */
+
+	protected function generate(string $abstract, ReflectionParameter $dependency) : Closure
+	{
+		if ($class = $dependency->getClass()) {
+			$classname = $class->name;
+			$key = $abstract.$classname;
+
+			if (isset($this->dependencies[$key])) {
+				return $this->dependencies[$key];
+			}
+
+			return function () use ($classname) {
+				return $this->make($classname);
+			};
+		}
+
+		return $class->getDefaultValue();
+	}
+
+	/**
+	 * Reset the container, removing all the elements, cache and options.
+	 *
+	 * @return self
+	 */
+
+	public function flush() : self
+	{
+		$this->collection = [];
+		$this->dependencies = [];
+		$this->resolving = [];
+		$this->resolved = [];
+
+		return $this;
+	}
+
+	/**
+	 * Finds an entry of the container by its identifier and returns it.
+	 *
+	 * @param string $abstract Identifier of the entry to look for.
+	 *
+	 * @throws \Psr\Container\Exception\NotFoundException  No entry was found for this identifier.
+	 * @throws \Psr\Container\Exception\ContainerException Error while retrieving the entry.
+	 *
+	 * @return mixed Entry.
+	 */
+	public function get($abstract)
+	{
+		if (! isset($this->collection[$abstract])) {
+			throw new NotFoundException("Element '$abstract' not found");
+		}
+
+		if ($this->collection[$abstract] instanceof Closure) {
+			try {
+				return $this->collection[$abstract]($this);
+			} catch (Exception $e) {
+				throw new ContainerException("An exception was thrown while attempt to make $abstract", 0, $e);
+			}
+		}
+
+		return $this->collection[$abstract];
+	}
+
+	/**
+	 * Returns true if the container can return an entry for the given identifier.
+	 * Returns false otherwise.
+	 *
+	 * `has($abstract)` returning true does not mean that `get($abstract)` will not throw an exception.
+	 * It does however mean that `get($abstract)` will not throw a `NotFoundException`.
+	 *
+	 * @param string $abstract Identifier of the entry to look for.
+	 *
+	 * @return boolean
+	 */
+
+	public function has($abstract)
+	{
+		return isset($this->collection[$abstract]);
+	}
+
+	/**
+	 * Verify if an element has a singleton instance.
+	 *
+	 * @param  string The class name or container element name to resolve dependencies.
+	 * @return bool
+	 */
+
+	public function isSingleton(string $abstract) : bool
+	{
+		return isset($this->collection[$abstract]) && $this->collection[$abstract] instanceof Closure === false;
+	}
+
+	/**
+	 * Verify if an element is a instance of something.
+	 *
+	 * @param  string The class name or container element name to resolve dependencies.
+	 * @return bool
+	 */
+	public function isInstance(string $abstract) : bool
+	{
+		return isset($this->collection[$abstract]) && is_object($this->collection[$abstract]);
+	}
+
+	/**
+	 * Bind a new element to the container.
+	 *
+	 * @param string                $abstract The alias name that will be used to call the element.
+	 * @param string|closure|object $concrete The element class name, or an closure that makes the element, or the object itself.
+	 * @param bool                  $shared   Define if the element will be a singleton instance.
+	 *
+	 * @return \Codeburner\Container\Container
+	 */
+
+	public function set(string $abstract, $concrete, bool $shared = false) : self
+	{
+		if (is_object($concrete)) {
+			return $this->instance($abstract, $concrete);
+		}
+
+		if ($concrete instanceof Closure === false) {
+			$concrete = function (Container $container) use ($concrete) {
+				return $container->make($concrete);
+			};
+		}
+
+		if ($shared === true) {
+			   $this->collection[$abstract] = $concrete($this);
+		} else $this->collection[$abstract] = $concrete;
+
+		return $this;
+	}
+
+	/**
+	 * Bind a new element to the container IF the element name not exists in the container.
+	 *
+	 * @param string         $abstract The alias name that will be used to call the element.
+	 * @param string|closure $concrete The element class name, or an closure that makes the element.
+	 * @param bool           $shared   Define if the element will be a singleton instance.
+	 *
+	 * @return \Codeburner\Container\Container
+	 */
+
+	public function setIf(string $abstract, $concrete, bool $shared = false) : self
+	{
+		if (! isset($this->collection[$abstract])) {
+			$this->set($abstract, $concrete, $shared);
+		}
+
+		return $this;
+	}
+
+	/**
+	 * Bind an specific instance to a class dependency.
+	 *
+	 * @param string         $class          The class full name.
+	 * @param string         $dependencyName The dependency full name.
+	 * @param string|closure $dependency     The specific object class name or a classure that makes the element.
+	 *
+	 * @return \Codeburner\Container\Container
+	 */
+
+	public function setTo(string $class, string $dependencyName, $dependency) : self
+	{
+		if ($dependency instanceof Closure === false) {
+			if (is_object($dependency)) {
+				$dependency = function () use ($dependency) {
+					return $dependency;
+				};
+			} else {
+				$dependency = function () use ($dependency) {
+					return $this->get($dependency);
+				};
+			}
+		}
+
+		$this->dependencies[$class.$dependencyName] = $dependency;
+
+		return $this;
+	}
+
+	/**
+	 * Bind an element that will be construct only one time, and every call for the element,
+	 * the same instance will be given.
+	 *
+	 * @param string         $abstract The alias name that will be used to call the element.
+	 * @param string|closure $concrete The element class name, or an closure that makes the element.
+	 *
+	 * @return \Codeburner\Container\Container
+	 */
+
+	public function singleton(string $abstract, $concrete) : self
+	{
+		$this->set($abstract, $concrete, true);
+
+		return $this;
+	}
+
+	/**
+	 * Bind an object to the container.
+	 *
+	 * @param string $abstract The alias name that will be used to call the object.
+	 * @param object $instance The object that will be inserted.
+	 *
+	 * @throws \Psr\Container\Exception\ContainerException When $instance is not an object.
+	 * @return \Codeburner\Container\Container
+	 */
+
+	public function instance(string $abstract, $instance) : self
+	{
+		if (! is_object($instance)) {
+			throw new ContainerException('Trying to store ' . gettype($type) . ' as object.');
+		}
+
+		$this->collection[$abstract] = $instance;
+
+		return $this;
+	}
+
+	/**
+	 * Modify an element with a given function that receive the old element as argument.
+	 *
+	 * @param string  $abstract  The alias name that will be used to call the element.
+	 * @param closure $extension The function that receives the old element and return a new or modified one.
+	 *
+	 * @throws \Psr\Container\Exception\NotFoundException  When no element was found with $abstract key.
+	 * @return \Codeburner\Container\Container
+	 */
+
+	public function extend(string $abstract, closure $extension) : self
+	{
+		if (! isset($this->collection[$abstract])) {
+			throw new NotFoundException;
+		}
+
+		$object = $this->collection[$abstract];
+
+		if ($object instanceof Closure) {
+			$this->collection[$abstract] = function () use ($object, $extension) {
+				return $extension($object($this), $this);
+			};
+		} else {
+			$this->collection[$abstract] = $extension($object, $this);
+		}
+
+		return $this;
+	}
+
+	/**
+	 * Makes an resolvable element an singleton.
+	 *
+	 * @param  string $abstract The alias name that will be used to call the element.
+	 *
+	 * @throws \Psr\Container\Exception\NotFoundException  When no element was found with $abstract key.
+	 * @throws \Psr\Container\Exception\ContainerException When the element on $abstract key is not resolvable.
+	 *
+	 * @return \Codeburner\Container\Container
+	 */
+
+	public function share(string $abstract) : self
+	{
+		if (! isset($this->collection[$abstract])) {
+			throw new NotFoundException("Element '$abstract' not found");
+		}
+
+		if (! $this->collection[$abstract] instanceof Closure) {
+			throw new ContainerException("'$abstract' must be a resolvable element");
+		}
+
+		$this->collection[$abstract] = $this->collection[$abstract]($this);
+
+		return $this;
+	}
 
 }