- Replaced closures with factories for [performance](per #3 in top answer at http://stackoverflow.com/questions/14667621/zf2-optimize-for-high-traffic)

claytondaley · claytondaley · commit b8505240d4a4 · 2015-01-31T18:06:50.000-05:00
- CreateForm and EditForm add hydrator (per ZfcUser settings) in `__construct`.  This makes it available to extend during the form `init` event.
 - Converted EditForm to inherit directly from Base rather than indirectly through Register (requires ZfcUser PR)
 - Converted EditForm to store data using `$form-&gt;bind($object)` pattern often used in Zend Forms (requires ZfcUser PR to avoid sending password to browser)
 - Forms now use an enhanced Validation Group logic.  Elements are selectively excluded based on specific options or attributes.  This significantly improves extensibility.
 - Cleaned out old helper code
 - Now repopulates disabled fields (side-effect)
diff --git a/config/services.config.php b/config/services.config.php
@@ -4,96 +4,16 @@
  * Date: 3/18/13
  * Time: 6:39 PM
  */
-use Zend\ServiceManager\ServiceLocatorInterface;
-use ZfcUser\Form\RegisterFilter;
-use ZfcUser\Mapper\UserHydrator;
-use ZfcUser\Validator\NoRecordExists;
-use ZfcUserAdmin\Form;
-use ZfcUserAdmin\Options;
-use ZfcUserAdmin\Validator\NoRecordExistsEdit;
 
 return array(
     'invokables' => array(
-        'ZfcUserAdmin\Form\EditUser' => 'ZfcUserAdmin\Form\EditUser',
-        'zfcuseradmin_user_service' => 'ZfcUserAdmin\Service\User',
+        'ZfcUserAdmin\Form\EditUser'        => 'ZfcUserAdmin\Form\EditUser',
+        'zfcuseradmin_user_service'         => 'ZfcUserAdmin\Service\User',
     ),
     'factories' => array(
-        'zfcuseradmin_module_options' => function (ServiceLocatorInterface $sm) {
-            $config = $sm->get('Config');
-            return new Options\ModuleOptions(isset($config['zfcuseradmin']) ? $config['zfcuseradmin'] : array());
-        },
-        'zfcuseradmin_edituser_form' => function (ServiceLocatorInterface $sm) {
-            /** @var $zfcUserOptions \ZfcUser\Options\UserServiceOptionsInterface */
-            $zfcUserOptions = $sm->get('zfcuser_module_options');
-            /** @var $zfcUserAdminOptions \ZfcUserAdmin\Options\ModuleOptions */
-            $zfcUserAdminOptions = $sm->get('zfcuseradmin_module_options');
-            $form = new Form\EditUser(null, $zfcUserAdminOptions, $zfcUserOptions, $sm);
-            $filter = new RegisterFilter(
-                new NoRecordExistsEdit(array(
-                    'mapper' => $sm->get('zfcuser_user_mapper'),
-                    'key' => 'email'
-                )),
-                new NoRecordExistsEdit(array(
-                    'mapper' => $sm->get('zfcuser_user_mapper'),
-                    'key' => 'username'
-                )),
-                $zfcUserOptions
-            );
-            if (!$zfcUserAdminOptions->getAllowPasswordChange()) {
-                $filter->remove('password')->remove('passwordVerify');
-            } else {
-                $filter->get('password')->setRequired(false);
-                $filter->remove('passwordVerify');
-            }
-            $form->setInputFilter($filter);
-            return $form;
-        },
-        'zfcuseradmin_createuser_form' => function (ServiceLocatorInterface $sm) {
-            /** @var $zfcUserOptions \ZfcUser\Options\UserServiceOptionsInterface */
-            $zfcUserOptions = $sm->get('zfcuser_module_options');
-            /** @var $zfcUserAdminOptions \ZfcUserAdmin\Options\ModuleOptions */
-            $zfcUserAdminOptions = $sm->get('zfcuseradmin_module_options');
-            $form = new Form\CreateUser(null, $zfcUserAdminOptions, $zfcUserOptions, $sm);
-            $filter = new RegisterFilter(
-                new NoRecordExists(array(
-                    'mapper' => $sm->get('zfcuser_user_mapper'),
-                    'key' => 'email'
-                )),
-                new NoRecordExists(array(
-                    'mapper' => $sm->get('zfcuser_user_mapper'),
-                    'key' => 'username'
-                )),
-                $zfcUserOptions
-            );
-            if ($zfcUserAdminOptions->getCreateUserAutoPassword()) {
-                $filter->remove('password')->remove('passwordVerify');
-            }
-            $form->setInputFilter($filter);
-            return $form;
-        },
-        'zfcuser_user_mapper' => function (ServiceLocatorInterface $sm) {
-            /** @var $config \ZfcUserAdmin\Options\ModuleOptions */
-            $config = $sm->get('zfcuseradmin_module_options');
-            $mapperClass = $config->getUserMapper();
-            if (stripos($mapperClass, 'doctrine') !== false) {
-                $mapper = new $mapperClass(
-                    $sm->get('zfcuser_doctrine_em'),
-                    $sm->get('zfcuser_module_options')
-                );
-            } else {
-                /** @var $zfcUserOptions \ZfcUser\Options\UserServiceOptionsInterface */
-                $zfcUserOptions = $sm->get('zfcuser_module_options');
-
-                /** @var $mapper \ZfcUserAdmin\Mapper\UserZendDb */
-                $mapper = new $mapperClass();
-                $mapper->setDbAdapter($sm->get('zfcuser_zend_db_adapter'));
-                $entityClass = $zfcUserOptions->getUserEntityClass();
-                $mapper->setEntityPrototype(new $entityClass);
-                $mapper->setHydrator($sm->get('zfcuser_user_hydrator'));
-                $mapper->setTableName($zfcUserOptions->getTableName());
-            }
-
-            return $mapper;
-        },
+        'zfcuseradmin_module_options'       => 'ZfcUserAdmin\Factory\Options\ModuleOptionsFactory',
+        'zfcuser_user_mapper'               => 'ZfcUserAdmin\Factory\Mapper\UserZendDbFactory',
+        'zfcuseradmin_createuser_form'      => 'ZfcUserAdmin\Factory\Form\CreateUserFactory',
+        'zfcuseradmin_edituser_form'        => 'ZfcUserAdmin\Factory\Form\EditUserFactory',
     ),
 );
diff --git a/src/ZfcUserAdmin/Controller/UserAdminController.php b/src/ZfcUserAdmin/Controller/UserAdminController.php
@@ -40,19 +40,19 @@ public function createAction()
     {
         /** @var $form \ZfcUserAdmin\Form\CreateUser */
         $form = $this->getServiceLocator()->get('zfcuseradmin_createuser_form');
+        /** @var $request \Zend\Http\Request */
         $request = $this->getRequest();
 
-        /** @var $request \Zend\Http\Request */
         if ($request->isPost()) {
             $zfcUserOptions = $this->getZfcUserOptions();
             $class = $zfcUserOptions->getUserEntityClass();
             $user = new $class();
-            $form->setHydrator(new ClassMethods());
             $form->bind($user);
+
             $form->setData($request->getPost());
 
             if ($form->isValid()) {
-                $user = $this->getAdminUserService()->create($form, (array)$request->getPost());
+                $user = $this->getAdminUserService()->create($form, (array)$request->getPost(), $user);
                 if ($user) {
                     $this->flashMessenger()->addSuccessMessage('The user was created');
                     return $this->redirect()->toRoute('zfcadmin/zfcuseradmin/list');
@@ -67,15 +67,17 @@ public function createAction()
 
     public function editAction()
     {
-        $userId = $this->getEvent()->getRouteMatch()->getParam('userId');
-        $user = $this->getUserMapper()->findById($userId);
-
         /** @var $form \ZfcUserAdmin\Form\EditUser */
         $form = $this->getServiceLocator()->get('zfcuseradmin_edituser_form');
-        $form->setUser($user);
-
         /** @var $request \Zend\Http\Request */
         $request = $this->getRequest();
+
+        $userId = $this->getEvent()->getRouteMatch()->getParam('userId');
+        $user = $this->getUserMapper()->findById($userId);
+        $form->bind($user);
+
+        // don't automatically overwrite password since input permit blank
+        $form->getInputFilter()->remove('password');
         if ($request->isPost()) {
             $form->setData($request->getPost());
             if ($form->isValid()) {
@@ -85,9 +87,10 @@ public function editAction()
                     return $this->redirect()->toRoute('zfcadmin/zfcuseradmin/list');
                 }
             }
-        } else {
-            $form->populateFromUser($user);
         }
+        // Necessary so validators know whether a username and email have changed since they may be a "duplicate" of
+        // their own database record, but not of other users.
+        $form->get('userId')->setValue($user->getId());
 
         return array(
             'editUserForm' => $form,
diff --git a/src/ZfcUserAdmin/Factory/Form/CreateUserFactory.php b/src/ZfcUserAdmin/Factory/Form/CreateUserFactory.php
@@ -0,0 +1,42 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: Clayton Daley
+ * Date: 1/31/2015
+ * Time: 1:06 PM
+ */
+
+namespace ZfcUserAdmin\Factory\Form;
+
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+use ZfcUser\Form\RegisterFilter;
+use ZfcUser\Validator\NoRecordExists;
+use ZfcUserAdmin\Form\CreateUser;
+
+class CreateUserFactory implements FactoryInterface {
+
+    function createService(ServiceLocatorInterface $serviceLocator) {
+        /** @var $zfcUserOptions \ZfcUser\Options\UserServiceOptionsInterface */
+        $zfcUserOptions = $serviceLocator->get('zfcuser_module_options');
+        /** @var $zfcUserAdminOptions \ZfcUserAdmin\Options\ModuleOptions */
+        $zfcUserAdminOptions = $serviceLocator->get('zfcuseradmin_module_options');
+        $form = new CreateUser(null, $zfcUserAdminOptions, $zfcUserOptions, $serviceLocator);
+        $filter = new RegisterFilter(
+            new NoRecordExists(array(
+                'mapper' => $serviceLocator->get('zfcuser_user_mapper'),
+                'key' => 'email'
+            )),
+            new NoRecordExists(array(
+                'mapper' => $serviceLocator->get('zfcuser_user_mapper'),
+                'key' => 'username'
+            )),
+            $zfcUserOptions
+        );
+        if ($zfcUserAdminOptions->getCreateUserAutoPassword()) {
+            $filter->remove('password')->remove('passwordVerify');
+        }
+        $form->setInputFilter($filter);
+        return $form;
+    }
+}
diff --git a/src/ZfcUserAdmin/Factory/Form/EditUserFactory.php b/src/ZfcUserAdmin/Factory/Form/EditUserFactory.php
@@ -0,0 +1,45 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: Clayton Daley
+ * Date: 1/31/2015
+ * Time: 1:03 PM
+ */
+
+namespace ZfcUserAdmin\Factory\Form;
+
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+use ZfcUser\Form\RegisterFilter;
+use ZfcUserAdmin\Form\EditUser;
+use ZfcUserAdmin\Validator\NoRecordExistsEdit;
+
+class EditUserFactory implements FactoryInterface {
+
+    public function createService(ServiceLocatorInterface $serviceLocator) {
+        /** @var $zfcUserOptions \ZfcUser\Options\UserServiceOptionsInterface */
+        $zfcUserOptions = $serviceLocator->get('zfcuser_module_options');
+        /** @var $zfcUserAdminOptions \ZfcUserAdmin\Options\ModuleOptions */
+        $zfcUserAdminOptions = $serviceLocator->get('zfcuseradmin_module_options');
+        $form = new EditUser(null, $zfcUserAdminOptions, $zfcUserOptions, $serviceLocator);
+        $filter = new RegisterFilter(
+            new NoRecordExistsEdit(array(
+                'mapper' => $serviceLocator->get('zfcuser_user_mapper'),
+                'key' => 'email'
+            )),
+            new NoRecordExistsEdit(array(
+                'mapper' => $serviceLocator->get('zfcuser_user_mapper'),
+                'key' => 'username'
+            )),
+            $zfcUserOptions
+        );
+        if (!$zfcUserAdminOptions->getAllowPasswordChange()) {
+            $filter->remove('password')->remove('passwordVerify');
+        } else {
+            $filter->get('password')->setRequired(false);
+            $filter->remove('passwordVerify');
+        }
+        $form->setInputFilter($filter);
+        return $form;
+    }
+}
diff --git a/src/ZfcUserAdmin/Factory/Mapper/UserZendDbFactory.php b/src/ZfcUserAdmin/Factory/Mapper/UserZendDbFactory.php
@@ -0,0 +1,40 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: Clayton Daley
+ * Date: 1/31/2015
+ * Time: 1:09 PM
+ */
+
+namespace ZfcUserAdmin\Factory\Mapper;
+
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+
+class UserZendDbFactory implements FactoryInterface {
+
+    public function createService(ServiceLocatorInterface $serviceLocator) {
+        /** @var $config \ZfcUserAdmin\Options\ModuleOptions */
+        $config = $serviceLocator->get('zfcuseradmin_module_options');
+        $mapperClass = $config->getUserMapper();
+        if (stripos($mapperClass, 'doctrine') !== false) {
+            $mapper = new $mapperClass(
+                $serviceLocator->get('zfcuser_doctrine_em'),
+                $serviceLocator->get('zfcuser_module_options')
+            );
+        } else {
+            /** @var $zfcUserOptions \ZfcUser\Options\UserServiceOptionsInterface */
+            $zfcUserOptions = $serviceLocator->get('zfcuser_module_options');
+
+            /** @var $mapper \ZfcUserAdmin\Mapper\UserZendDb */
+            $mapper = new $mapperClass();
+            $mapper->setDbAdapter($serviceLocator->get('zfcuser_zend_db_adapter'));
+            $entityClass = $zfcUserOptions->getUserEntityClass();
+            $mapper->setEntityPrototype(new $entityClass);
+            $mapper->setHydrator($serviceLocator->get('zfcuser_user_hydrator'));
+            $mapper->setTableName($zfcUserOptions->getTableName());
+        }
+
+        return $mapper;
+    }
+}
diff --git a/src/ZfcUserAdmin/Factory/Options/ModuleOptionsFactory.php b/src/ZfcUserAdmin/Factory/Options/ModuleOptionsFactory.php
@@ -0,0 +1,21 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: Clayton Daley
+ * Date: 1/31/2015
+ * Time: 1:13 PM
+ */
+
+namespace ZfcUserAdmin\Factory\Options;
+
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+use ZfcUserAdmin\Options\ModuleOptions;
+
+class ModuleOptionsFactory implements FactoryInterface {
+
+    public function createService(ServiceLocatorInterface $serviceLocator) {
+        $config = $serviceLocator->get('Config');
+        return new ModuleOptions(isset($config['zfcuseradmin']) ? $config['zfcuseradmin'] : array());
+    }
+}
diff --git a/src/ZfcUserAdmin/Form/CreateUser.php b/src/ZfcUserAdmin/Form/CreateUser.php
@@ -2,9 +2,10 @@
 
 namespace ZfcUserAdmin\Form;
 
-use ZfcUserAdmin\Options\UserCreateOptionsInterface;
+use Zend\Stdlib\Hydrator\ClassMethods;
 use ZfcUser\Options\RegistrationOptionsInterface;
 use ZfcUser\Form\Register as Register;
+use ZfcUserAdmin\Options\UserCreateOptionsInterface;
 
 class CreateUser extends Register
 {
@@ -24,6 +25,8 @@ public function __construct($name = null, UserCreateOptionsInterface $createOpti
         $this->setCreateOptions($createOptions);
         $this->setServiceManager($serviceManager);
         parent::__construct($name, $registerOptions);
+        // ZfcUser should have setHydrator() which we replace or extend
+        $this->setHydrator($serviceManager->get('zfcuser_user_hydrator'));
 
         if ($createOptions->getCreateUserAutoPassword()) {
             $this->remove('password');
@@ -68,4 +71,34 @@ public function getServiceManager()
     {
         return $this->serviceManager;
     }
+
+    /**
+     * Override isValid() to set an validation group of all elements that do not
+     * have an 'exclude' option, if at least one element has this option set.
+     *
+     * @return boolean
+     */
+    public function isValid()
+    {
+        if ($this->hasValidated) {
+            return $this->isValid;
+        }
+
+        if ($this->getValidationGroup() === null) {
+            // Add all non-excluded elements to the validation group
+            $validationGroup = null;
+            foreach ($this->getElements() as $element) {
+                if ($element->getOption('exclude') === false or
+                    ($element->getAttribute('readonly') !== true && $element->getOption('exclude') !== true))
+                {
+                    $validationGroup[] = $element->getName();
+                }
+            }
+            if ($validationGroup) {
+                $this->setValidationGroup($validationGroup);
+            }
+        }
+
+        return parent::isValid();
+    }
 }
diff --git a/src/ZfcUserAdmin/Form/EditUser.php b/src/ZfcUserAdmin/Form/EditUser.php
diff --git a/src/ZfcUserAdmin/Service/User.php b/src/ZfcUserAdmin/Service/User.php
