merged branch kriswallsmith/security/demeter-fix (PR #2816)

fabpot · fabpot · commit 76ba2bc7accb · 2011-12-08T17:58:34.000+01:00
Commits ------- 41872cd [Security] added SecurityContextInterface::getUser() Discussion ---------- [Security] added SecurityContextInterface::getUser() This changes helps the common use case of fetching the current user and better complies with the [Law of Demeter][1]. Before (still works): $token = $context->getToken(); $user = $token ? $token->getUser() : null; After: $user = $context->getUser(); The fine print: ``` Bug fix: no Feature addition: yes Backwards compatibility break: no Symfony2 tests pass: yes Fixes the following tickets: ~ Todo: ~ ``` [1]: http://en.wikipedia.org/wiki/Law_of_Demeter
diff --git a/src/Symfony/Component/Security/Core/SecurityContext.php b/src/Symfony/Component/Security/Core/SecurityContext.php
@@ -89,4 +89,18 @@ public function setToken(TokenInterface $token = null)
     {
         $this->token = $token;
     }
+
+    /**
+     * Returns the current user, if one exists.
+     *
+     * @return mixed Returns either an object which implements __toString(),
+     *               or a primitive string if there is a token, otherwise
+     *               returns null.
+     */
+    public function getUser()
+    {
+        if ($this->token) {
+            return $this->token->getUser();
+        }
+    }
 }
diff --git a/src/Symfony/Component/Security/Core/SecurityContextInterface.php b/src/Symfony/Component/Security/Core/SecurityContextInterface.php
@@ -38,6 +38,15 @@ function getToken();
      */
     function setToken(TokenInterface $token = null);
 
+    /**
+     * Returns the current user, if one exists.
+     *
+     * @return mixed Returns either an object which implements __toString(),
+     *               or a primitive string if there is a token, otherwise
+     *               returns null.
+     */
+    function getUser();
+
     /**
      * Checks if the attributes are granted against the current authentication token and optionally supplied object.
      *
diff --git a/tests/Symfony/Tests/Component/Security/Core/SecurityContextTest.php b/tests/Symfony/Tests/Component/Security/Core/SecurityContextTest.php
@@ -89,4 +89,22 @@ public function testGetSetToken()
         $context->setToken($token = $this->getMock('Symfony\Component\Security\Core\Authentication\Token\TokenInterface'));
         $this->assertSame($token, $context->getToken());
     }
+
+    public function testGetUser()
+    {
+        $token = $this->getMock('Symfony\Component\Security\Core\Authentication\Token\TokenInterface');
+        $token->expects($this->once())
+            ->method('getUser')
+            ->will($this->returnValue('foo'));
+
+        $context = new SecurityContext(
+            $this->getMock('Symfony\Component\Security\Core\Authentication\AuthenticationManagerInterface'),
+            $this->getMock('Symfony\Component\Security\Core\Authorization\AccessDecisionManagerInterface')
+        );
+
+        $this->assertNull($context->getUser(), '->getUser() returns null when there is no token');
+
+        $context->setToken($token);
+        $this->assertEquals('foo', $context->getUser(), '->getUser() return the token user');
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -89,4 +89,18 @@ public function setToken(TokenInterface $token = null)`
`89`	`89`	`{`
`90`	`90`	`$this->token = $token;`
`91`	`91`	`}`
	`92`	`+`
	`93`	`+ /**`
	`94`	`+ * Returns the current user, if one exists.`
	`95`	`+ *`
	`96`	`+ * @return mixed Returns either an object which implements __toString(),`
	`97`	`+ * or a primitive string if there is a token, otherwise`
	`98`	`+ * returns null.`
	`99`	`+ */`
	`100`	`+ public function getUser()`
	`101`	`+ {`
	`102`	`+ if ($this->token) {`
	`103`	`+ return $this->token->getUser();`
	`104`	`+ }`
	`105`	`+ }`
`92`	`106`	`}`