[DependencyInjection] minor interface change

symfony · Feb 13, 2011 · d4d2d60 · d4d2d60
1 parent 205621d
commit d4d2d60
Show file tree

Hide file tree

Showing 7 changed files with 73 additions and 24 deletions.
diff --git a/src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php b/src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php
@@ -23,6 +23,7 @@
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\AddCacheWarmerPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Compiler\PassConfig;
+use Symfony\Component\DependencyInjection\Scope;
 use Symfony\Component\HttpFoundation\File\File;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 use Symfony\Component\ClassLoader\ClassCollectionLoader;
@@ -67,7 +68,7 @@ public function registerExtensions(ContainerBuilder $container)
     {
         parent::registerExtensions($container);
 
-        $container->addScope('request');
+        $container->addScope(new Scope('request'));
 
         $container->addCompilerPass(new RoutingResolverPass());
         $container->addCompilerPass(new ProfilerPass());

diff --git a/src/Symfony/Component/DependencyInjection/Container.php b/src/Symfony/Component/DependencyInjection/Container.php
@@ -334,12 +334,14 @@ public function leaveScope($name)
     /**
      * Adds a scope to the container
      *
-     * @param string $name
-     * @param string $parentScope
+     * @param ScopeInterface $scope
      * @return void
      */
-    public function addScope($name, $parentScope = self::SCOPE_CONTAINER)
+    public function addScope(ScopeInterface $scope)
     {
+        $name = $scope->getName();
+        $parentScope = $scope->getParentName();
+
         if (self::SCOPE_CONTAINER === $name || self::SCOPE_PROTOTYPE === $name) {
             throw new \InvalidArgumentException(sprintf('The scope "%s" is reserved.', $name));
         }

diff --git a/src/Symfony/Component/DependencyInjection/ContainerInterface.php b/src/Symfony/Component/DependencyInjection/ContainerInterface.php
@@ -104,11 +104,10 @@ function leaveScope($name);
     /**
      * Adds a scope to the container
      *
-     * @param string $name
-     * @param string $parentScope
+     * @param ScopeInterface $scope
      * @return void
      */
-    function addScope($name, $parentScope = self::SCOPE_CONTAINER);
+    function addScope(ScopeInterface $scope);
 
     /**
      * Whether this container has the given scope

diff --git a/src/Symfony/Component/DependencyInjection/Scope.php b/src/Symfony/Component/DependencyInjection/Scope.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection;
+
+/**
+ * Scope class.
+ *
+ * @author Johannes M. Schmitt <schmittjoh@gmail.com>
+ */
+class Scope implements ScopeInterface
+{
+    protected $name;
+    protected $parentName;
+
+    public function __construct($name, $parentName = ContainerInterface::SCOPE_CONTAINER)
+    {
+        $this->name = $name;
+        $this->parentName = $parentName;
+    }
+
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    public function getParentName()
+    {
+        return $this->parentName;
+    }
+}
diff --git a/src/Symfony/Component/DependencyInjection/ScopeInterface.php b/src/Symfony/Component/DependencyInjection/ScopeInterface.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace Symfony\Component\DependencyInjection;
+
+/**
+ * Scope Interface.
+ *
+ * @author Johannes M. Schmitt <schmittjoh@gmail.com>
+ */
+interface ScopeInterface
+{
+    function getName();
+    function getParentName();
+}
diff --git a/...s/Symfony/Tests/Component/DependencyInjection/Compiler/CheckReferenceValidityPassTest.php b/...s/Symfony/Tests/Component/DependencyInjection/Compiler/CheckReferenceValidityPassTest.php
@@ -2,6 +2,8 @@
 
 namespace Symfony\Tests\Component\DependencyInjection\Compiler;
 
+use Symfony\Component\DependencyInjection\Scope;
+
 use Symfony\Component\DependencyInjection\Compiler\CheckReferenceValidityPass;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\Reference;
@@ -33,8 +35,8 @@ public function testProcessDetectsScopeWidening()
     public function testProcessIgnoresCrossScopeHierarchyReferenceIfNotStrict()
     {
         $container = new ContainerBuilder();
-        $container->addScope('a');
-        $container->addScope('b');
+        $container->addScope(new Scope('a'));
+        $container->addScope(new Scope('b'));
 
         $container->register('a')->setScope('a')->addArgument(new Reference('b', ContainerInterface::EXCEPTION_ON_INVALID_REFERENCE, false));
         $container->register('b')->setScope('b');
@@ -48,8 +50,8 @@ public function testProcessIgnoresCrossScopeHierarchyReferenceIfNotStrict()
     public function testProcessDetectsCrossScopeHierarchyReference()
     {
         $container = new ContainerBuilder();
-        $container->addScope('a');
-        $container->addScope('b');
+        $container->addScope(new Scope('a'));
+        $container->addScope(new Scope('b'));
 
         $container->register('a')->setScope('a')->addArgument(new Reference('b'));
         $container->register('b')->setScope('b');

diff --git a/tests/Symfony/Tests/Component/DependencyInjection/ContainerTest.php b/tests/Symfony/Tests/Component/DependencyInjection/ContainerTest.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Tests\Component\DependencyInjection;
 
+use Symfony\Component\DependencyInjection\Scope;
 use Symfony\Component\DependencyInjection\Container;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
@@ -125,14 +126,14 @@ public function testSetDoesNotAllowPrototypeScope()
     public function testSetDoesNotAllowInactiveScope()
     {
         $c = new Container();
-        $c->addScope('foo');
+        $c->addScope(new Scope('foo'));
         $c->set('foo', new \stdClass(), 'foo');
     }
 
     public function testSetAlsoSetsScopedService()
     {
         $c = new Container();
-        $c->addScope('foo');
+        $c->addScope(new Scope('foo'));
         $c->enterScope('foo');
         $c->set('foo', $foo = new \stdClass(), 'foo');
 
@@ -183,7 +184,7 @@ public function testHas()
     public function testEnterLeaveCurrentScope()
     {
         $container = new ProjectServiceContainer();
-        $container->addScope('foo');
+        $container->addScope(new Scope('foo'));
 
         $container->enterScope('foo');
         $scoped1 = $container->get('scoped');
@@ -208,8 +209,8 @@ public function testEnterLeaveCurrentScope()
     public function testEnterLeaveScopeWithChildScopes()
     {
         $container = new Container();
-        $container->addScope('foo');
-        $container->addScope('bar', 'foo');
+        $container->addScope(new Scope('foo'));
+        $container->addScope(new Scope('bar', 'foo'));
 
         $this->assertFalse($container->isScopeActive('foo'));
 
@@ -243,7 +244,7 @@ public function testEnterLeaveScopeWithChildScopes()
     public function testAddScopeDoesNotAllowBuiltInScopes($scope)
     {
         $container = new Container();
-        $container->addScope($scope);
+        $container->addScope(new Scope($scope));
     }
 
     /**
@@ -252,8 +253,8 @@ public function testAddScopeDoesNotAllowBuiltInScopes($scope)
     public function testAddScopeDoesNotAllowExistingScope()
     {
         $container = new Container();
-        $container->addScope('foo');
-        $container->addScope('foo');
+        $container->addScope(new Scope('foo'));
+        $container->addScope(new Scope('foo'));
     }
 
     /**
@@ -263,14 +264,14 @@ public function testAddScopeDoesNotAllowExistingScope()
     public function testAddScopeDoesNotAllowInvalidParentScope($scope)
     {
         $c = new Container();
-        $c->addScope('foo', $scope);
+        $c->addScope(new Scope('foo', $scope));
     }
 
     public function testAddScope()
     {
         $c = new Container();
-        $c->addScope('foo');
-        $c->addScope('bar', 'foo');
+        $c->addScope(new Scope('foo'));
+        $c->addScope(new Scope('bar', 'foo'));
 
         $this->assertSame(array('foo' => 'container', 'bar' => 'foo'), $this->getField($c, 'scopes'));
         $this->assertSame(array('foo' => array('bar'), 'bar' => array()), $this->getField($c, 'scopeChildren'));
@@ -281,7 +282,7 @@ public function testHasScope()
         $c = new Container();
 
         $this->assertFalse($c->hasScope('foo'));
-        $c->addScope('foo');
+        $c->addScope(new Scope('foo'));
         $this->assertTrue($c->hasScope('foo'));
     }
 
@@ -290,7 +291,7 @@ public function testIsScopeActive()
         $c = new Container();
 
         $this->assertFalse($c->isScopeActive('foo'));
-        $c->addScope('foo');
+        $c->addScope(new Scope('foo'));
 
         $this->assertFalse($c->isScopeActive('foo'));
         $c->enterScope('foo');