Applied code styling and optimized use statements using PhpStorm. Did…

… check and make some adjustments here and there. Also updated few 'entityManager' usages to 'objectManager'.
rkeet · Jul 19, 2018 · bfdfa36 · bfdfa36
1 parent 8974de7
commit bfdfa36
Show file tree

Hide file tree

Showing 32 changed files with 492 additions and 337 deletions.
diff --git a/composer.json b/composer.json
@@ -1,20 +1,33 @@
 {
-    "name": "rkeet/zf-doctrine-form",
-    "description": "Zend Framework with Doctrine Form (Fieldset & InputFilter) usage focusing on re-usable components",
-    "keywords": ["zend", "framework", "zend framework", "mvc", "zf", "zf3", "form", "components", "fieldset", "input filter", "validator", "doctrine"],
-    "homepage": "http://keet.me/",
-    "require": {
-        "php": "^7.2",
-        "doctrine/doctrine-orm-module": "^1.1",
-        "zendframework/zend-math": "^3.0",
-        "zendframework/zend-session": "^2.8"
+  "name" : "rkeet/zf-doctrine-form",
+  "description" : "Zend Framework with Doctrine Form (Fieldset & InputFilter) usage focusing on re-usable components",
+  "keywords" : [
+    "zend",
+    "framework",
+    "zend framework",
+    "mvc",
+    "zf",
+    "zf3",
+    "form",
+    "components",
+    "fieldset",
+    "input filter",
+    "validator",
+    "doctrine"
+  ],
+  "homepage" : "http://keet.me/",
+  "require" : {
+    "php" : "^7.2",
+    "doctrine/doctrine-orm-module" : "^1.1",
+    "zendframework/zend-math" : "^3.0",
+    "zendframework/zend-session" : "^2.8"
+  },
+  "autoload" : {
+    "psr-4" : {
+      "Keet\\Form\\" : "src/"
     },
-    "autoload": {
-        "psr-4": {
-            "Keet\\Form\\": "src/"
-        },
-        "classmap": [
-            "src/Module.php"
-        ]
-    }
+    "classmap" : [
+      "src/Module.php"
+    ]
+  }
 }
diff --git a/config/module.config.php b/config/module.config.php
@@ -9,9 +9,9 @@
 use Zend\I18n\Translator\TranslatorServiceFactory;
 
 return [
-    'form_elements' => [
+    'form_elements'   => [
         'factories' => [
-            GenericDeleteForm::class => GenericDeleteFormFactory::class,
+            GenericDeleteForm::class         => GenericDeleteFormFactory::class,
             GenericDoctrineDeleteForm::class => GenericDoctrineDeleteFormFactory::class,
         ],
     ],
@@ -20,10 +20,11 @@
             'translator' => TranslatorServiceFactory::class,
         ],
     ],
-    'view_manager' => [
+    'view_manager'    => [
         'template_map' => [
-            'keet/partials/form/genericDeleteForm' => __DIR__ . '/../view/partials/generic-delete-form.phtml',
-            'keet/partials/form/genericDoctrineDeleteForm' => __DIR__ . '/../view/partials/generic-doctrine-delete-form.phtml',
+            'keet/partials/form/genericDeleteForm'         => __DIR__ . '/../view/partials/generic-delete-form.phtml',
+            'keet/partials/form/genericDoctrineDeleteForm' => __DIR__
+                . '/../view/partials/generic-doctrine-delete-form.phtml',
         ],
     ],
 ];
diff --git a/src/Factory/AbstractDoctrineFieldsetFactory.php b/src/Factory/AbstractDoctrineFieldsetFactory.php
@@ -2,6 +2,7 @@
 
 namespace Keet\Form\Factory;
 
+use Doctrine\Common\Persistence\ObjectManager;
 use Doctrine\ORM\EntityManager;
 use DoctrineModule\Stdlib\Hydrator\DoctrineObject;
 use Interop\Container\ContainerInterface;
@@ -10,30 +11,31 @@
 abstract class AbstractDoctrineFieldsetFactory extends AbstractFieldsetFactory
 {
     /**
-     * @var EntityManager
+     * @var ObjectManager|EntityManager
      */
-    protected $entityManager;
+    protected $objectManager;
 
     /**
      * @param ContainerInterface $container
-     * @param string $requestedName
-     * @param array|null $options
+     * @param string             $requestedName
+     * @param array|null         $options
+     *
      * @return AbstractDoctrineFieldset
      * @throws \Psr\Container\ContainerExceptionInterface
      * @throws \Psr\Container\NotFoundExceptionInterface
      */
     public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
     {
-        $this->setEntityManager($container->get(EntityManager::class));
+        $this->setObjectManager($container->get(EntityManager::class));
         $this->setTranslator($container->get('translator'));
 
         $fieldset = $this->getFieldset();
         $fieldsetObject = $this->getFieldsetObject();
 
         /** @var AbstractDoctrineFieldset $fieldset */
-        $fieldset = new $fieldset($this->getEntityManager(), $this->name ?: $this->getFieldsetName());
+        $fieldset = new $fieldset($this->getObjectManager(), $this->name ?: $this->getFieldsetName());
         $fieldset->setHydrator(
-            new DoctrineObject($this->getEntityManager())
+            new DoctrineObject($this->getObjectManager())
         );
         $fieldset->setObject(new $fieldsetObject());
         $fieldset->setTranslator($this->getTranslator());
@@ -44,18 +46,19 @@ public function __invoke(ContainerInterface $container, $requestedName, array $o
     /**
      * @return EntityManager
      */
-    public function getEntityManager(): EntityManager
+    public function getObjectManager() : ObjectManager
     {
-        return $this->entityManager;
+        return $this->objectManager;
     }
 
     /**
-     * @param EntityManager $entityManager
+     * @param ObjectManager $objectManager
+     *
      * @return AbstractDoctrineFieldsetFactory
      */
-    public function setEntityManager(EntityManager $entityManager): AbstractDoctrineFieldsetFactory
+    public function setObjectManager(ObjectManager $objectManager) : AbstractDoctrineFieldsetFactory
     {
-        $this->entityManager = $entityManager;
+        $this->objectManager = $objectManager;
         return $this;
     }
 

diff --git a/src/Factory/AbstractDoctrineFieldsetInputFilterFactory.php b/src/Factory/AbstractDoctrineFieldsetInputFilterFactory.php
@@ -10,6 +10,7 @@
 
 /**
  * Class AbstractFieldsetInputFilterFactory
+ *
  * @package Keet\Form\Factory
  *
  * Creating FieldsetInputFilterFactory classes is, alas, pretty much a custom job each and every time. However,
@@ -32,7 +33,8 @@ abstract class AbstractDoctrineFieldsetInputFilterFactory extends AbstractFields
      * Use this function to setup the basic requirements commonly reused.
      *
      * @param ContainerInterface $container
-     * @param string|null $className
+     * @param string|null        $className
+     *
      * @throws \Psr\Container\ContainerExceptionInterface
      * @throws \Psr\Container\NotFoundExceptionInterface
      */
@@ -43,23 +45,27 @@ public function setupRequirements(ContainerInterface $container, $className = nu
         $this->setInputFilterManager($container->get(InputFilterPluginManager::class));
 
         if (isset($className) && class_exists($className)) {
-            $this->setObjectRepository($this->getObjectManager()->getRepository($className));
+            $this->setObjectRepository(
+                $this->getObjectManager()
+                     ->getRepository($className)
+            );
         }
     }
 
     /**
      * @return ObjectManager
      */
-    public function getObjectManager(): ObjectManager
+    public function getObjectManager() : ObjectManager
     {
         return $this->objectManager;
     }
 
     /**
      * @param ObjectManager $objectManager
+     *
      * @return AbstractDoctrineFieldsetInputFilterFactory
      */
-    public function setObjectManager(ObjectManager $objectManager): AbstractDoctrineFieldsetInputFilterFactory
+    public function setObjectManager(ObjectManager $objectManager) : AbstractDoctrineFieldsetInputFilterFactory
     {
         $this->objectManager = $objectManager;
         return $this;
@@ -68,16 +74,17 @@ public function setObjectManager(ObjectManager $objectManager): AbstractDoctrine
     /**
      * @return ObjectRepository
      */
-    public function getObjectRepository(): ObjectRepository
+    public function getObjectRepository() : ObjectRepository
     {
         return $this->objectRepository;
     }
 
     /**
      * @param ObjectRepository $objectRepository
+     *
      * @return AbstractDoctrineFieldsetInputFilterFactory
      */
-    public function setObjectRepository(ObjectRepository $objectRepository): AbstractDoctrineFieldsetInputFilterFactory
+    public function setObjectRepository(ObjectRepository $objectRepository) : AbstractDoctrineFieldsetInputFilterFactory
     {
         $this->objectRepository = $objectRepository;
         return $this;

diff --git a/src/Factory/AbstractDoctrineFormFactory.php b/src/Factory/AbstractDoctrineFormFactory.php
@@ -7,6 +7,7 @@
 use Doctrine\ORM\EntityManager;
 use Interop\Container\ContainerInterface;
 use Keet\Form\Form\AbstractDoctrineForm;
+use Keet\Form\Form\AbstractForm;
 
 abstract class AbstractDoctrineFormFactory extends AbstractFormFactory
 {
@@ -17,19 +18,21 @@ abstract class AbstractDoctrineFormFactory extends AbstractFormFactory
 
     /**
      * @param ContainerInterface $container
-     * @param string $requestedName
-     * @param array|null $options
+     * @param string             $requestedName
+     * @param array|null         $options
+     *
      * @return AbstractDoctrineForm
      * @throws \Psr\Container\ContainerExceptionInterface
      * @throws \Psr\Container\NotFoundExceptionInterface
      */
-    public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
+    public function __invoke(ContainerInterface $container, $requestedName, array $options = null) : AbstractForm
     {
         $this->setObjectManager($container->get(EntityManager::class));
         $this->setTranslator($container->get('translator'));
         $this->setInputFilterPluginManager($container->get('InputFilterManager'));
 
-        $inputFilter = $this->getInputFilterPluginManager()->get($this->getFormInputFilter());
+        $inputFilter = $this->getInputFilterPluginManager()
+                            ->get($this->getFormInputFilter());
 
         $form = $this->getForm();
 
@@ -46,32 +49,34 @@ public function __invoke(ContainerInterface $container, $requestedName, array $o
      * Checks if received class is an Entity
      *
      * @param ObjectManager $objectManager
-     * @param string|object $class
+     * @param string|\object $class
      *
      * @return boolean
      */
     function isEntity(ObjectManager $objectManager, $class)
     {
-        if(is_object($class)){
+        if (is_object($class)) {
             $class = ClassUtils::getClass($class);
         }
 
-        return ! $objectManager->getMetadataFactory()->isTransient($class);
+        return ! $objectManager->getMetadataFactory()
+                               ->isTransient($class);
     }
 
     /**
      * @return ObjectManager
      */
-    public function getObjectManager(): ObjectManager
+    public function getObjectManager() : ObjectManager
     {
         return $this->objectManager;
     }
 
     /**
      * @param ObjectManager $objectManager
+     *
      * @return AbstractDoctrineFormFactory
      */
-    public function setObjectManager(ObjectManager $objectManager): AbstractDoctrineFormFactory
+    public function setObjectManager(ObjectManager $objectManager) : AbstractDoctrineFormFactory
     {
         $this->objectManager = $objectManager;
         return $this;

diff --git a/src/Factory/AbstractDoctrineFormInputFilterFactory.php b/src/Factory/AbstractDoctrineFormInputFilterFactory.php
@@ -24,7 +24,8 @@ abstract class AbstractDoctrineFormInputFilterFactory extends AbstractFieldsetIn
      * Use this function to setup the basic requirements commonly reused.
      *
      * @param ContainerInterface $container
-     * @param string|null $className
+     * @param string|null        $className
+     *
      * @throws \Psr\Container\ContainerExceptionInterface
      * @throws \Psr\Container\NotFoundExceptionInterface
      */
@@ -35,23 +36,27 @@ public function setupRequirements(ContainerInterface $container, $className = nu
         $this->setInputFilterManager($container->get(InputFilterPluginManager::class));
 
         if (isset($className) && class_exists($className)) {
-            $this->setObjectRepository($this->getObjectManager()->getRepository($className));
+            $this->setObjectRepository(
+                $this->getObjectManager()
+                     ->getRepository($className)
+            );
         }
     }
 
     /**
      * @return ObjectManager
      */
-    public function getObjectManager(): ObjectManager
+    public function getObjectManager() : ObjectManager
     {
         return $this->objectManager;
     }
 
     /**
      * @param ObjectManager $objectManager
+     *
      * @return AbstractDoctrineFormInputFilterFactory
      */
-    public function setObjectManager(ObjectManager $objectManager): AbstractDoctrineFormInputFilterFactory
+    public function setObjectManager(ObjectManager $objectManager) : AbstractDoctrineFormInputFilterFactory
     {
         $this->objectManager = $objectManager;
         return $this;
@@ -60,16 +65,17 @@ public function setObjectManager(ObjectManager $objectManager): AbstractDoctrine
     /**
      * @return ObjectRepository
      */
-    public function getObjectRepository(): ObjectRepository
+    public function getObjectRepository() : ObjectRepository
     {
         return $this->objectRepository;
     }
 
     /**
      * @param ObjectRepository $objectRepository
+     *
      * @return AbstractDoctrineFormInputFilterFactory
      */
-    public function setObjectRepository(ObjectRepository $objectRepository): AbstractDoctrineFormInputFilterFactory
+    public function setObjectRepository(ObjectRepository $objectRepository) : AbstractDoctrineFormInputFilterFactory
     {
         $this->objectRepository = $objectRepository;
         return $this;