Merge branch 'feature/psr-11'

dmitry-suffi · Oct 13, 2017 · dde91d5 · dde91d5
2 parents 5403a53 + d58e507
commit dde91d5
Show file tree

Hide file tree

Showing 14 changed files with 228 additions and 95 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 .idea
 
+vander
 phpunit.phar
 tests/test
diff --git a/README.md b/README.md
@@ -9,6 +9,8 @@ Dependency injection container
 
 Dependency injection container — it is an object to instantiate the class and its dependent objects.
 
+This is in accordance with the recommendations of PSR-11.
+
 It supports the following kinds of dependency injection:
 
 * Constructor injection;

diff --git a/composer.json b/composer.json
@@ -8,7 +8,8 @@
     "support": {},
     "minimum-stability": "stable",
     "require": {
-        "php": ">=7.0.0"
+        "php": ">=7.0.0",
+        "psr/container": "*"
     },
     "require-dev": {
         "phpunit/phpunit": "5.4.*",

diff --git a/di/Container.php b/di/Container.php
@@ -2,11 +2,13 @@
 
 namespace suffi\di;
 
+use Psr\Container\ContainerInterface;
+
 /**
  * Class Container
  * @package suffi\di
  */
-class Container
+class Container implements ContainerInterface
 {
     /**
      * @var array
@@ -116,25 +118,27 @@ public function hasDefinition(string $name)
      * Set in container
      * @param string $key
      * @param $instance
-     * @throws Exception
+     * @throws ContainerException
      */
     public function set(string $key, $instance)
     {
         if (!is_object($instance)) {
-            throw new Exception('Value is not object');
+            throw new ContainerException('Value is not object');
         }
 
         /** is not singleton */
         $this->container[$key] = $instance;
     }
 
     /**
-     * Get by key
-     * @param string $key
-     * @return object|false
+     * @inheritdoc
      */
-    public function get(string $key)
+    public function get($key)
     {
+        if (!is_string($key)) {
+            throw new ContainerException("Identifier is not string");
+        }
+
         if (isset($this->singletones[$key])) {
             return $this->singletones[$key];
         }
@@ -148,20 +152,23 @@ public function get(string $key)
             return $this->container[$key];
         }
 
-        if (isset($this->aliases[$key])) {
-            return $this->get($this->aliases[$key]);
+        if ($this->hasAlias($key)) {
+            return $this->get($this->getAlias($key));
         }
 
-        return false;
+        throw new NotFoundException("No entry was found for $key identifier");
+
     }
 
     /**
-     * Has instance by key
-     * @param string $key
-     * @return bool
+     * @inheritdoc
      */
-    public function has(string $key)
+    public function has($key)
     {
+        if (!is_string($key)) {
+            throw new ContainerException("Identifier is not string");
+        }
+
         return $this->hasSingleton($key) || isset($this->container[$key]) || ($this->hasAlias($key) && $this->has($this->getAlias($key)));
     }
 
@@ -178,40 +185,21 @@ public function remove(string $key)
      * Set singleton in container
      * @param string $key
      * @param object $instance
-     * @throws Exception
+     * @throws ContainerException
      */
     public function setSingleton(string $key, $instance)
     {
         if ($this->hasSingleton($key)) {
-            throw new Exception($key . ' is singleton!');
+            throw new ContainerException($key . ' is singleton!');
         }
 
         if (!is_object($instance)) {
-            throw new Exception('Value is not object');
+            throw new ContainerException('Value is not object');
         }
 
         $this->singletones[$key] = $instance;
     }
 
-    /**
-     * Get singleton by key
-     * @param string $key
-     * @return Object|false
-     */
-    protected function getSingleton(string $key)
-    {
-        return $this->singletones[$key] ?? false;
-    }
-
-    /**
-     * Remove singleton by $key
-     * @param string $key
-     */
-    protected function removeSingleton(string $key)
-    {
-        unset($this->singletones[$key]);
-    }
-
     /**
      * Has singleton by $key
      * @param string $key

diff --git a/di/ContainerException.php b/di/ContainerException.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace suffi\di;
+
+use Psr\Container\ContainerExceptionInterface;
+
+/**
+ * Class Exception
+ * @package suffi\di
+ */
+class ContainerException extends \Exception implements ContainerExceptionInterface
+{
+
+}
diff --git a/di/Definition.php b/di/Definition.php
@@ -44,11 +44,11 @@ final class Definition
     public function __construct(Container $container, string $name, string $className)
     {
         if (!$name) {
-            throw new \Exception('Name is not found!');
+            throw new ContainerException('Name is not found!');
         }
 
         if (!$className) {
-            throw new \Exception('ClassName is not found!');
+            throw new ContainerException('ClassName is not found!');
         }
 
         $this->container = $container;
@@ -114,12 +114,13 @@ public function setter(string $paramName, $paramValue)
 
     /**
      * @return object
-     * @throws Exception
+     * @throws NotFoundException
+     * @throws ContainerException
      */
     public function make()
     {
         if (!class_exists($this->className)) {
-            throw new Exception(sprintf('Class %s not found', $this->className));
+            throw new NotFoundException(sprintf('Class %s not found', $this->className));
         }
 
         $reflection = new \ReflectionClass($this->className);
@@ -157,7 +158,7 @@ public function make()
                         } else {
                             /** No is optional */
                             if (!$param->isOptional()) {
-                                throw new Exception(sprintf('Do not set the parameter %s to constructor', $param->getName()));
+                                throw new ContainerException(sprintf('Do not set the parameter %s to constructor', $param->getName()));
                             }
                         }
                     }
@@ -179,7 +180,7 @@ public function make()
 
             if ($property) {
                 if (!$property->isPublic()) {
-                    throw new Exception(sprintf('%s Class %s property is not public', $this->className, $name));
+                    throw new ContainerException(sprintf('%s Class %s property is not public', $this->className, $name));
                 }
                 if ($property->isStatic()) {
                     $property->setValue($value);
@@ -196,15 +197,15 @@ public function make()
             $method = $reflection->getMethod($settersName);
             if ($method) {
                 if ($method->isAbstract()) {
-                    throw new Exception(sprintf('%s:%s - abstract class method', $this->className, $settersName));
+                    throw new ContainerException(sprintf('%s:%s - abstract class method', $this->className, $settersName));
                 }
                 if (!$method->isPublic()) {
-                    throw new Exception(sprintf('%s:%s is not public method', $this->className, $settersName));
+                    throw new ContainerException(sprintf('%s:%s is not public method', $this->className, $settersName));
                 }
 
                 $parameters = $method->getParameters();
                 if (!isset($parameters[0])) {
-                    throw new Exception(sprintf('Method %s has no input parameters', $settersName));
+                    throw new ContainerException(sprintf('Method %s has no input parameters', $settersName));
                 }
 
                 $param = $parameters[0];
@@ -229,16 +230,16 @@ public function make()
         /** Init */
         if ($this->initMethod) {
             if (!method_exists($instance, $this->initMethod)) {
-                throw new Exception(sprintf('Method %s is not found in class %s', $this->className, $this->initMethod));
+                throw new ContainerException(sprintf('Method %s is not found in class %s', $this->className, $this->initMethod));
             }
 
             $method = $reflection->getMethod($this->initMethod);
 
             if ($method->isAbstract()) {
-                throw new Exception(sprintf('%s:%s - abstract class method', $this->className, $this->initMethod));
+                throw new ContainerException(sprintf('%s:%s - abstract class method', $this->className, $this->initMethod));
             }
             if (!$method->isPublic()) {
-                throw new Exception(sprintf('%s:%s is not public method', $this->className, $this->initMethod));
+                throw new ContainerException(sprintf('%s:%s is not public method', $this->className, $this->initMethod));
             }
 
             if ($method->isStatic()) {
@@ -265,7 +266,7 @@ public function init(string $methodName)
      * @todo пока только для конструктора и сеттеров, возможно сделать для публичных свойств ?
      * @param string $className
      * @return object
-     * @throws Exception
+     * @throws NotFoundException
      */
     protected function resolve(string $className)
     {
@@ -277,7 +278,7 @@ protected function resolve(string $className)
             return $this->container->getDefinition($className)->make();
         }
 
-        throw new Exception(sprintf('Definition for %s is not found', $className));
+        throw new NotFoundException(sprintf('Definition for %s is not found', $className));
     }
 
     /**

diff --git a/di/Exception.php b/di/Exception.php
diff --git a/di/ExtendedContainer.php b/di/ExtendedContainer.php
@@ -33,19 +33,27 @@ public function setParentsContainer(Container $parentsContainer)
     /**
      * @inheritdoc
      */
-    public function get(string $key)
+    public function get($key)
     {
-        $obj = parent::get($key);
-        if (!$obj && !is_null($this->parentsContainer)) {
-            $obj = $this->parentsContainer->get($key);
+        try{
+            $obj = parent::get($key);
+
+            return $obj;
         }
-        return $obj;
+        catch (NotFoundException $e) {
+            if (!is_null($this->parentsContainer)) {
+                return $this->parentsContainer->get($key);
+            } else {
+                throw $e;
+            }
+        }
+
     }
 
     /**
      * @inheritdoc
      */
-    public function has(string $key)
+    public function has($key)
     {
         $has = parent::has($key);
 
@@ -80,15 +88,6 @@ public function hasDefinition(string $key)
         return $has;
     }
 
-    protected function getSingleton(string $key)
-    {
-        $obj = parent::getSingleton($key);
-        if (!$obj && !is_null($this->parentsContainer)) {
-            $obj = $this->parentsContainer->getSingleton($key);
-        }
-        return $obj;
-    }
-
     public function hasSingleton(string $key)
     {
         $has = parent::hasSingleton($key);

diff --git a/di/NotFoundException.php b/di/NotFoundException.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace suffi\di;
+
+use Psr\Container\NotFoundExceptionInterface;
+
+/**
+ * Class Exception
+ * @package suffi\di
+ */
+class NotFoundException extends ContainerException implements NotFoundExceptionInterface
+{
+
+}
diff --git a/docs/Readme.md b/docs/Readme.md
@@ -7,6 +7,8 @@ Dependency injection container
 
 Dependency injection container — it is an object to instantiate the class and its dependent objects.
 
+This is in accordance with the recommendations of PSR-11.
+
 It supports the following kinds of dependency injection:
 
 * Constructor injection;