Switched the documentation from Markdown to ReStructuredText

Changelog.md

@@ -1,6 +1,27 @@
 Changelog
 =========
 
+### 2.0.0 (2014-XX-XX)
+
+* [BC break] The deprecated entity classes have been removed.
+* The minimum requirement for Symfony has been bumped to 2.3 (older versions are already EOLed).
+* [BC break] ``UserInterface::isUser`` has been removed as it was used only by the old validation logic removed a long time ago.
+* [BC break] The ``FOSUserBundle:Security:login.html.twig`` template now receives an AuthenticationException in the ``error``
+  variable rather than an error message.
+* [BC break] The templating engine configuration has been removed, as well as the related code.
+* [BC break] Changed the XML namespace to `http://friendsofsymfony.github.io/schema/dic/user`
+
+### 2.0.0-alpha1 (2014-09-26)
+
+* Updated many translations
+* Changed the way to pass the email to the page asking to check the email to avoid issues with non-blocking sessions
+* Changed the fos_user_security_check route to enforce POST
+* Removed the deprecated UserManager and GroupManager classes for the different Doctrine implementations
+* [BC break] Refactored the structure of controller to dispatch events instead of using form handlers
+* Removed all form handlers
+* [BC break] Changed Datetime properties of default User entity that were nullable to default to null when no value supplied
+* [BC break] Updated schema.xml for Propel BaseUser class to allow nullable and typehint accordingly
+
 ### 1.3.5 (2014-09-04)
 
 This release fixes a security issue. You are encouraged to update

Command/ChangePasswordCommand.php

@@ -17,7 +17,7 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 /**
- * CreateUserCommand
+ * ChangePasswordCommand
  */
 class ChangePasswordCommand extends ContainerAwareCommand
 {
@@ -83,7 +83,7 @@ function($username) {
         }
 
         if (!$input->getArgument('password')) {
-            $password = $this->getHelper('dialog')->askAndValidate(
+            $password = $this->getHelper('dialog')->askHiddenResponseAndValidate(
                 $output,
                 'Please enter the new password:',
                 function($password) {

Command/CreateUserCommand.php

@@ -115,7 +115,7 @@ function($email) {
         }
 
         if (!$input->getArgument('password')) {
-            $password = $this->getHelper('dialog')->askAndValidate(
+            $password = $this->getHelper('dialog')->askHiddenResponseAndValidate(
                 $output,
                 'Please choose a password:',
                 function($password) {

Controller/ChangePasswordController.php

@@ -11,63 +11,73 @@
 
 namespace FOS\UserBundle\Controller;
 
-use Symfony\Component\DependencyInjection\ContainerAware;
+use FOS\UserBundle\FOSUserEvents;
+use FOS\UserBundle\Event\FormEvent;
+use FOS\UserBundle\Event\FilterUserResponseEvent;
+use FOS\UserBundle\Event\GetResponseUserEvent;
+use FOS\UserBundle\Model\UserInterface;
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\Security\Core\Exception\AccessDeniedException;
-use FOS\UserBundle\Model\UserInterface;
 
 /**
  * Controller managing the password change
  *
  * @author Thibault Duplessis <[email protected]>
  * @author Christophe Coevoet <[email protected]>
  */
-class ChangePasswordController extends ContainerAware
+class ChangePasswordController extends Controller
 {
     /**
      * Change user password
      */
-    public function changePasswordAction()
+    public function changePasswordAction(Request $request)
     {
-        $user = $this->container->get('security.context')->getToken()->getUser();
+        $user = $this->getUser();
         if (!is_object($user) || !$user instanceof UserInterface) {
             throw new AccessDeniedException('This user does not have access to this section.');
         }
 
-        $form = $this->container->get('fos_user.change_password.form');
-        $formHandler = $this->container->get('fos_user.change_password.form.handler');
+        /** @var $dispatcher \Symfony\Component\EventDispatcher\EventDispatcherInterface */
+        $dispatcher = $this->get('event_dispatcher');
 
-        $process = $formHandler->process($user);
-        if ($process) {
-            $this->setFlash('fos_user_success', 'change_password.flash.success');
+        $event = new GetResponseUserEvent($user, $request);
+        $dispatcher->dispatch(FOSUserEvents::CHANGE_PASSWORD_INITIALIZE, $event);
 
-            return new RedirectResponse($this->getRedirectionUrl($user));
+        if (null !== $event->getResponse()) {
+            return $event->getResponse();
         }
 
-        return $this->container->get('templating')->renderResponse(
-            'FOSUserBundle:ChangePassword:changePassword.html.'.$this->container->getParameter('fos_user.template.engine'),
-            array('form' => $form->createView())
-        );
-    }
+        /** @var $formFactory \FOS\UserBundle\Form\Factory\FactoryInterface */
+        $formFactory = $this->get('fos_user.change_password.form.factory');
 
-    /**
-     * Generate the redirection url when the resetting is completed.
-     *
-     * @param \FOS\UserBundle\Model\UserInterface $user
-     *
-     * @return string
-     */
-    protected function getRedirectionUrl(UserInterface $user)
-    {
-        return $this->container->get('router')->generate('fos_user_profile_show');
-    }
+        $form = $formFactory->createForm();
+        $form->setData($user);
 
-    /**
-     * @param string $action
-     * @param string $value
-     */
-    protected function setFlash($action, $value)
-    {
-        $this->container->get('session')->getFlashBag()->set($action, $value);
+        $form->handleRequest($request);
+
+        if ($form->isValid()) {
+            /** @var $userManager \FOS\UserBundle\Model\UserManagerInterface */
+            $userManager = $this->get('fos_user.user_manager');
+
+            $event = new FormEvent($form, $request);
+            $dispatcher->dispatch(FOSUserEvents::CHANGE_PASSWORD_SUCCESS, $event);
+
+            $userManager->updateUser($user);
+
+            if (null === $response = $event->getResponse()) {
+                $url = $this->generateUrl('fos_user_profile_show');
+                $response = new RedirectResponse($url);
+            }
+
+            $dispatcher->dispatch(FOSUserEvents::CHANGE_PASSWORD_COMPLETED, new FilterUserResponseEvent($user, $request, $response));
+
+            return $response;
+        }
+
+        return $this->render('FOSUserBundle:ChangePassword:changePassword.html.twig', array(
+            'form' => $form->createView()
+        ));
     }
 }

Controller/GroupController.php

@@ -11,7 +11,13 @@
 
 namespace FOS\UserBundle\Controller;
 
-use Symfony\Component\DependencyInjection\ContainerAware;
+use FOS\UserBundle\FOSUserEvents;
+use FOS\UserBundle\Event\FilterGroupResponseEvent;
+use FOS\UserBundle\Event\FormEvent;
+use FOS\UserBundle\Event\GetResponseGroupEvent;
+use FOS\UserBundle\Event\GroupEvent;
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
@@ -21,83 +27,139 @@
  * @author Thibault Duplessis <[email protected]>
  * @author Christophe Coevoet <[email protected]>
  */
-class GroupController extends ContainerAware
+class GroupController extends Controller
 {
     /**
      * Show all groups
      */
     public function listAction()
     {
-        $groups = $this->container->get('fos_user.group_manager')->findGroups();
+        $groups = $this->get('fos_user.group_manager')->findGroups();
 
-        return $this->container->get('templating')->renderResponse('FOSUserBundle:Group:list.html.'.$this->getEngine(), array('groups' => $groups));
+        return $this->render('FOSUserBundle:Group:list.html.twig', array(
+            'groups' => $groups
+        ));
     }
 
     /**
      * Show one group
      */
-    public function showAction($groupname)
+    public function showAction($groupName)
     {
-        $group = $this->findGroupBy('name', $groupname);
+        $group = $this->findGroupBy('name', $groupName);
 
-        return $this->container->get('templating')->renderResponse('FOSUserBundle:Group:show.html.'.$this->getEngine(), array('group' => $group));
+        return $this->render('FOSUserBundle:Group:show.html.twig', array(
+            'group' => $group
+        ));
     }
 
     /**
      * Edit one group, show the edit form
      */
-    public function editAction($groupname)
+    public function editAction(Request $request, $groupName)
     {
-        $group = $this->findGroupBy('name', $groupname);
-        $form = $this->container->get('fos_user.group.form');
-        $formHandler = $this->container->get('fos_user.group.form.handler');
+        $group = $this->findGroupBy('name', $groupName);
 
-        $process = $formHandler->process($group);
-        if ($process) {
-            $this->setFlash('fos_user_success', 'group.flash.updated');
-            $groupUrl =  $this->container->get('router')->generate('fos_user_group_show', array('groupname' => $group->getName()));
+        /** @var $dispatcher \Symfony\Component\EventDispatcher\EventDispatcherInterface */
+        $dispatcher = $this->get('event_dispatcher');
 
-            return new RedirectResponse($groupUrl);
+        $event = new GetResponseGroupEvent($group, $request);
+        $dispatcher->dispatch(FOSUserEvents::GROUP_EDIT_INITIALIZE, $event);
+
+        if (null !== $event->getResponse()) {
+            return $event->getResponse();
         }
 
-        return $this->container->get('templating')->renderResponse('FOSUserBundle:Group:edit.html.'.$this->getEngine(), array(
+        /** @var $formFactory \FOS\UserBundle\Form\Factory\FactoryInterface */
+        $formFactory = $this->get('fos_user.group.form.factory');
+
+        $form = $formFactory->createForm();
+        $form->setData($group);
+
+        $form->handleRequest($request);
+
+        if ($form->isValid()) {
+            /** @var $groupManager \FOS\UserBundle\Model\GroupManagerInterface */
+            $groupManager = $this->get('fos_user.group_manager');
+
+            $event = new FormEvent($form, $request);
+            $dispatcher->dispatch(FOSUserEvents::GROUP_EDIT_SUCCESS, $event);
+
+            $groupManager->updateGroup($group);
+
+            if (null === $response = $event->getResponse()) {
+                $url = $this->generateUrl('fos_user_group_show', array('groupName' => $group->getName()));
+                $response = new RedirectResponse($url);
+            }
+
+            $dispatcher->dispatch(FOSUserEvents::GROUP_EDIT_COMPLETED, new FilterGroupResponseEvent($group, $request, $response));
+
+            return $response;
+        }
+
+        return $this->render('FOSUserBundle:Group:edit.html.twig', array(
             'form'      => $form->createview(),
-            'groupname'  => $group->getName(),
+            'group_name'  => $group->getName(),
         ));
     }
 
     /**
      * Show the new form
      */
-    public function newAction()
+    public function newAction(Request $request)
     {
-        $form = $this->container->get('fos_user.group.form');
-        $formHandler = $this->container->get('fos_user.group.form.handler');
+        /** @var $groupManager \FOS\UserBundle\Model\GroupManagerInterface */
+        $groupManager = $this->get('fos_user.group_manager');
+        /** @var $formFactory \FOS\UserBundle\Form\Factory\FactoryInterface */
+        $formFactory = $this->get('fos_user.group.form.factory');
+        /** @var $dispatcher \Symfony\Component\EventDispatcher\EventDispatcherInterface */
+        $dispatcher = $this->get('event_dispatcher');
+
+        $group = $groupManager->createGroup('');
+
+        $dispatcher->dispatch(FOSUserEvents::GROUP_CREATE_INITIALIZE, new GroupEvent($group, $request));
 
-        $process = $formHandler->process();
-        if ($process) {
-            $this->setFlash('fos_user_success', 'group.flash.created');
-            $parameters = array('groupname' => $form->getData('group')->getName());
-            $url = $this->container->get('router')->generate('fos_user_group_show', $parameters);
+        $form = $formFactory->createForm();
+        $form->setData($group);
 
-            return new RedirectResponse($url);
+        $form->handleRequest($request);
+
+        if ($form->isValid()) {
+            $event = new FormEvent($form, $request);
+            $dispatcher->dispatch(FOSUserEvents::GROUP_CREATE_SUCCESS, $event);
+
+            $groupManager->updateGroup($group);
+
+            if (null === $response = $event->getResponse()) {
+                $url = $this->generateUrl('fos_user_group_show', array('groupName' => $group->getName()));
+                $response = new RedirectResponse($url);
+            }
+
+            $dispatcher->dispatch(FOSUserEvents::GROUP_CREATE_COMPLETED, new FilterGroupResponseEvent($group, $request, $response));
+
+            return $response;
         }
 
-        return $this->container->get('templating')->renderResponse('FOSUserBundle:Group:new.html.'.$this->getEngine(), array(
+        return $this->render('FOSUserBundle:Group:new.html.twig', array(
             'form' => $form->createview(),
         ));
     }
 
     /**
      * Delete one group
      */
-    public function deleteAction($groupname)
+    public function deleteAction(Request $request, $groupName)
     {
-        $group = $this->findGroupBy('name', $groupname);
-        $this->container->get('fos_user.group_manager')->deleteGroup($group);
-        $this->setFlash('fos_user_success', 'group.flash.deleted');
+        $group = $this->findGroupBy('name', $groupName);
+        $this->get('fos_user.group_manager')->deleteGroup($group);
+
+        $response = new RedirectResponse($this->generateUrl('fos_user_group_list'));
 
-        return new RedirectResponse($this->container->get('router')->generate('fos_user_group_list'));
+        /** @var $dispatcher \Symfony\Component\EventDispatcher\EventDispatcherInterface */
+        $dispatcher = $this->get('event_dispatcher');
+        $dispatcher->dispatch(FOSUserEvents::GROUP_DELETE_COMPLETED, new FilterGroupResponseEvent($group, $request, $response));
+
+        return $response;
     }
 
     /**
@@ -106,13 +168,13 @@ public function deleteAction($groupname)
      * @param string $key   property name
      * @param mixed  $value property value
      *
-     * @throws NotFoundException                    if user does not exist
+     * @throws NotFoundHttpException                if user does not exist
      * @return \FOS\UserBundle\Model\GroupInterface
      */
     protected function findGroupBy($key, $value)
     {
         if (!empty($value)) {
-            $group = $this->container->get('fos_user.group_manager')->{'findGroupBy'.ucfirst($key)}($value);
+            $group = $this->get('fos_user.group_manager')->{'findGroupBy'.ucfirst($key)}($value);
         }
 
         if (empty($group)) {
@@ -121,18 +183,4 @@ protected function findGroupBy($key, $value)
 
         return $group;
     }
-
-    protected function getEngine()
-    {
-        return $this->container->getParameter('fos_user.template.engine');
-    }
-
-    /**
-     * @param string $action
-     * @param string $value
-     */
-    protected function setFlash($action, $value)
-    {
-        $this->container->get('session')->getFlashBag()->set($action, $value);
-    }
 }