[symfony#1874] Tweaking the entity provider article, including a new explanation of why serialization might be important

weaverryan · weaverryan · commit 5547d661178d · 2012-11-22T12:46:01.000-05:00
diff --git a/cookbook/security/entity_provider.rst b/cookbook/security/entity_provider.rst
@@ -54,7 +54,7 @@ focus on the most important methods that come from the
      * @ORM\Table(name="acme_users")
      * @ORM\Entity(repositoryClass="Acme\UserBundle\Entity\UserRepository")
      */
-    class User implements UserInterface
+    class User implements UserInterface, \Serializable
     {
         /**
          * @ORM\Column(type="integer")
@@ -140,6 +140,26 @@ focus on the most important methods that come from the
         {
             return $this->username === $user->getUsername();
         }
+
+        /**
+         * @see \Serializable::serialize()
+         */
+        public function serialize()
+        {
+            return serialize(array(
+                $this->id,
+            ));
+        }
+
+        /**
+         * @see \Serializable::unserialize()
+         */
+        public function unserialize($serialized)
+        {
+            list (
+                $this->id,
+            ) = unserialize($serialized);
+        }
     }
 
 In order to use an instance of the ``AcmeUserBundle:User`` class in the Symfony
@@ -161,6 +181,15 @@ but it's also possible to do more checks depending on the complexity of your
 data model. On the other hand, the ``eraseCredentials()`` method remains empty
 for the purposes of this tutorial.
 
+.. note::
+
+    The :phpclass:`Serializable` interface and its ``serialize`` and ``unserialize``
+    methods have been added to allow the ``User`` class to be serialized
+    to the session. This may or may not be needed depending on your setup,
+    but it's probably a good idea. Only the ``id`` needs to be serialized,
+    because the :method:`Symfony\\Bridge\\Doctrine\\Security\\User\\EntityUserProvider::refreshUser`
+    method reloads the user on each request by using the ``id``.
+
 Below is an export of my ``User`` table from MySQL. For details on how to
 create user records and encode their password, see :ref:`book-security-encoding-user-password`.
 
@@ -361,7 +390,7 @@ The code below shows the implementation of the
                 throw new UnsupportedUserException(sprintf('Instances of "%s" are not supported.', $class));
             }
 
-            return $this->findOneById($user->getId());
+            return $this->find($user->getId());
         }
 
         public function supportsClass($class)
