feature #9782 [Security] added string representation for core Users (tobiassjosten)

fabpot · fabpot · commit 542f60457d56 · 2015-02-05T16:54:07.000+01:00
This PR was submitted for the master branch but it was merged into the 2.7 branch instead (closes #9782). Discussion ---------- [Security] added string representation for core Users | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | I often use type casting and `__toString()` to print my users as this lets me very easily keep one canonical format for their representation. In functional tests however, it is easier to use in-memory users but this defaults to instances of the core `User` object. Because these don't have a string representation all the nice type casting crashes. Hence I propose to represent the core Users by their username string by default. It would be useful in a lot of cases and I can't see any harm in it? Commits ------- 722c3a7 [Security] added string representation for core Users
diff --git a/src/Symfony/Component/Security/Core/Tests/User/UserTest.php b/src/Symfony/Component/Security/Core/Tests/User/UserTest.php
@@ -123,4 +123,13 @@ public function testEraseCredentials()
         $user->eraseCredentials();
         $this->assertEquals('superpass', $user->getPassword());
     }
+
+    /**
+     * @covers Symfony\Component\Security\Core\User\User::__toString
+     */
+    public function testToString()
+    {
+        $user = new User('fabien', 'superpass');
+        $this->assertEquals('fabien', (string) $user);
+    }
 }
diff --git a/src/Symfony/Component/Security/Core/User/User.php b/src/Symfony/Component/Security/Core/User/User.php
@@ -43,6 +43,11 @@ public function __construct($username, $password, array $roles = array(), $enabl
         $this->roles = $roles;
     }
 
+    public function __toString()
+    {
+        return $this->getUsername();
+    }
+
     /**
      * {@inheritdoc}
      */

Original file line number	Diff line number	Diff line change
`@@ -123,4 +123,13 @@ public function testEraseCredentials()`
`123`	`123`	`$user->eraseCredentials();`
`124`	`124`	`$this->assertEquals('superpass', $user->getPassword());`
`125`	`125`	`}`
	`126`	`+`
	`127`	`+ /**`
	`128`	`+ * @covers Symfony\Component\Security\Core\User\User::__toString`
	`129`	`+ */`
	`130`	`+ public function testToString()`
	`131`	`+ {`
	`132`	`+ $user = new User('fabien', 'superpass');`
	`133`	`+ $this->assertEquals('fabien', (string) $user);`
	`134`	`+ }`
`126`	`135`	`}`