Fixes #409 Remove scopes

The goal is to simplify the package for the v6. Scopes are useless: I don't see a valid use case for the "prototype" scope, if needed then it should be replaced by an actual factory. By removing scopes the API would be simpler as well as the internals of PHP-DI.
PHP-DI · Jun 1, 2016 · 8b7fb34 · 8b7fb34
1 parent 854a6d8
commit 8b7fb34
Show file tree

Hide file tree

Showing 57 changed files with 52 additions and 793 deletions.
diff --git a/change-log.md b/change-log.md
@@ -1,5 +1,9 @@
 # Change log
 
+## 6.0
+
+- [#409](https://github.com/PHP-DI/PHP-DI/issues/409): Scopes are removed (by [@mnapoli](https://github.com/mnapoli))
+
 ## 5.3
 
 Read the [news entry](news/19-php-di-5-3-released.md).

diff --git a/couscous.yml b/couscous.yml
@@ -82,9 +82,6 @@ menu:
                 performances:
                     text: Performances
                     url: doc/performances.html
-                scopes:
-                    text: Scopes
-                    url: doc/scopes.html
                 lazy-injection:
                     text: Lazy injection
                     url: doc/lazy-injection.html

diff --git a/doc/README.md b/doc/README.md
@@ -34,7 +34,6 @@ title: Documentation index
 ### Advanced topics
 
 * [Performances](performances.md)
-* [Scopes](scopes.md)
 * [Lazy injection](lazy-injection.md)
 * [Inject on an existing instance](inject-on-instance.md)
 * [Injections depending on the environment](environments.md)

diff --git a/doc/annotations.md b/doc/annotations.md
@@ -108,7 +108,7 @@ The `@Injectable` annotation lets you set options on injectable classes:
 
 ```php
 /**
- * @Injectable(scope="prototype", lazy=true)
+ * @Injectable(lazy=true)
  */
 class Example
 {

diff --git a/doc/php-definitions.md b/doc/php-definitions.md
@@ -277,14 +277,7 @@ return [
 ];
 ```
 
-By default each entry will be created once and the same instance will be injected everywhere it is used (singleton instance). You can use the "prototype" [scope](scopes.md) if you want a new instance to be created every time it is injected:
-
-```php
-return [
-    'FormBuilder' => DI\object()
-        ->scope(Scope::PROTOTYPE),
-];
-```
+Each entry will be resolved once and the same instance will be injected everywhere it is used.
 
 ### Aliases
 

diff --git a/doc/scopes.md b/doc/scopes.md
diff --git a/src/DI/Annotation/Injectable.php b/src/DI/Annotation/Injectable.php
@@ -2,9 +2,6 @@
 
 namespace DI\Annotation;
 
-use DI\Scope;
-use UnexpectedValueException;
-
 /**
  * "Injectable" annotation.
  *
@@ -18,12 +15,6 @@
  */
 final class Injectable
 {
-    /**
-     * The scope of an class: prototype, singleton.
-     * @var string|null
-     */
-    private $scope;
-
     /**
      * Should the object be lazy-loaded.
      * @var bool|null
@@ -35,28 +26,11 @@ final class Injectable
      */
     public function __construct(array $values)
     {
-        if (isset($values['scope'])) {
-            if ($values['scope'] === 'prototype') {
-                $this->scope = Scope::PROTOTYPE;
-            } elseif ($values['scope'] === 'singleton') {
-                $this->scope = Scope::SINGLETON;
-            } else {
-                throw new UnexpectedValueException(sprintf("Value '%s' is not a valid scope", $values['scope']));
-            }
-        }
         if (isset($values['lazy'])) {
             $this->lazy = (bool) $values['lazy'];
         }
     }
 
-    /**
-     * @return string|null
-     */
-    public function getScope()
-    {
-        return $this->scope;
-    }
-
     /**
      * @return bool|null
      */

diff --git a/src/DI/Container.php b/src/DI/Container.php
@@ -32,10 +32,10 @@
 class Container implements ContainerInterface, FactoryInterface, \DI\InvokerInterface
 {
     /**
-     * Map of entries with Singleton scope that are already resolved.
+     * Map of entries that are already resolved.
      * @var array
      */
-    private $singletonEntries = [];
+    private $resolvedEntries = [];
 
     /**
      * @var DefinitionSource
@@ -85,9 +85,9 @@ public function __construct(
         $this->definitionResolver = new ResolverDispatcher($this->wrapperContainer, $proxyFactory);
 
         // Auto-register the container
-        $this->singletonEntries[self::class] = $this;
-        $this->singletonEntries[FactoryInterface::class] = $this;
-        $this->singletonEntries[InvokerInterface::class] = $this;
+        $this->resolvedEntries[self::class] = $this;
+        $this->resolvedEntries[FactoryInterface::class] = $this;
+        $this->resolvedEntries[InvokerInterface::class] = $this;
     }
 
     /**
@@ -109,9 +109,9 @@ public function get($name)
             ));
         }
 
-        // Try to find the entry in the singleton map
-        if (array_key_exists($name, $this->singletonEntries)) {
-            return $this->singletonEntries[$name];
+        // If the entry is already resolved we return it
+        if (array_key_exists($name, $this->resolvedEntries)) {
+            return $this->resolvedEntries[$name];
         }
 
         $definition = $this->definitionSource->getDefinition($name);
@@ -121,20 +121,16 @@ public function get($name)
 
         $value = $this->resolveDefinition($definition);
 
-        // If the entry is singleton, we store it to always return it without recomputing it
-        if ($definition->getScope() === Scope::SINGLETON) {
-            $this->singletonEntries[$name] = $value;
-        }
+        $this->resolvedEntries[$name] = $value;
 
         return $value;
     }
 
     /**
      * Build an entry of the container by its name.
      *
-     * This method behave like get() except it forces the scope to "prototype",
-     * which means the definition of the entry will be re-evaluated each time.
-     * For example, if the entry is a class, then a new instance will be created each time.
+     * This method behave like get() except resolves the entry again every time.
+     * For example if the entry is a class then a new instance will be created each time.
      *
      * This method makes the container behave like a factory.
      *
@@ -159,9 +155,9 @@ public function make($name, array $parameters = [])
 
         $definition = $this->definitionSource->getDefinition($name);
         if (! $definition) {
-            // Try to find the entry in the singleton map
-            if (array_key_exists($name, $this->singletonEntries)) {
-                return $this->singletonEntries[$name];
+            // If the entry is already resolved we return it
+            if (array_key_exists($name, $this->resolvedEntries)) {
+                return $this->resolvedEntries[$name];
             }
 
             throw new NotFoundException("No entry or class found for '$name'");
@@ -187,7 +183,7 @@ public function has($name)
             ));
         }
 
-        if (array_key_exists($name, $this->singletonEntries)) {
+        if (array_key_exists($name, $this->resolvedEntries)) {
             return true;
         }
 
@@ -255,7 +251,7 @@ public function set($name, $value)
         if ($value instanceof Definition) {
             $this->setDefinition($name, $value);
         } else {
-            $this->singletonEntries[$name] = $value;
+            $this->resolvedEntries[$name] = $value;
         }
     }
 
@@ -305,8 +301,8 @@ private function setDefinition($name, Definition $definition)
         }
 
         // Clear existing entry if it exists
-        if (array_key_exists($name, $this->singletonEntries)) {
-            unset($this->singletonEntries[$name]);
+        if (array_key_exists($name, $this->resolvedEntries)) {
+            unset($this->resolvedEntries[$name]);
         }
 
         $this->definitionSource->addDefinition($definition);

diff --git a/src/DI/Definition/AliasDefinition.php b/src/DI/Definition/AliasDefinition.php
@@ -2,7 +2,6 @@
 
 namespace DI\Definition;
 
-use DI\Scope;
 use Interop\Container\ContainerInterface;
 
 /**
@@ -42,14 +41,6 @@ public function getName()
         return $this->name;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getScope()
-    {
-        return Scope::PROTOTYPE;
-    }
-
     /**
      * @return string
      */

diff --git a/src/DI/Definition/ArrayDefinition.php b/src/DI/Definition/ArrayDefinition.php
@@ -3,7 +3,6 @@
 namespace DI\Definition;
 
 use DI\Definition\Helper\DefinitionHelper;
-use DI\Scope;
 
 /**
  * Definition of an array containing values or references.
@@ -42,14 +41,6 @@ public function getName()
         return $this->name;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getScope()
-    {
-        return Scope::SINGLETON;
-    }
-
     /**
      * @return array
      */

diff --git a/src/DI/Definition/Definition.php b/src/DI/Definition/Definition.php
@@ -18,13 +18,6 @@ interface Definition extends RequestedEntry
      */
     public function getName();
 
-    /**
-     * Returns the scope of the entry.
-     *
-     * @return string
-     */
-    public function getScope();
-
     /**
      * Definitions can be cast to string for debugging information.
      *

diff --git a/src/DI/Definition/Dumper/ObjectDefinitionDumper.php b/src/DI/Definition/Dumper/ObjectDefinitionDumper.php
@@ -34,9 +34,6 @@ public function dump(ObjectDefinition $definition)
         }
         $str = sprintf('    class = %s%s', $warning, $className);
 
-        // Scope
-        $str .= PHP_EOL . '    scope = ' . $definition->getScope();
-
         // Lazy
         $str .= PHP_EOL . '    lazy = ' . var_export($definition->isLazy(), true);