Unify Service/Host/UserGroup code for Objects and Forms

At least as far as possible. For objects, moved some common parts to IcingaObjectGroup, where zone_id is now in defaultProperties and thus those don't need to be overriden in IcingaHostGroup and IcingaServiceGroup anymore. Similar for relations property, which don't need to be specified in descendant classes anymore. For forms, created a intermediate class IcingaGroupForm (analog to the already existing IcingaObjectGroup for objects) which extends DirectorObjectForm, and made IcingaHostGroupForm, IcingaServiceGroupForm and IcingaUserGroupForm extend this new class instead. Moved the addZoneElements method to this new class, thus removing it from the descendant classes that had it repeated.
Icinga · Feb 3, 2023 · 5f0caa3 · 5f0caa3
1 parent 2ffa700
commit 5f0caa3
Show file tree

Hide file tree

Showing 8 changed files with 42 additions and 93 deletions.
diff --git a/application/forms/IcingaGroupForm.php b/application/forms/IcingaGroupForm.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace Icinga\Module\Director\Forms;
+
+use Icinga\Module\Director\Web\Form\DirectorObjectForm;
+
+class IcingaGroupForm extends DirectorObjectForm
+{
+    /**
+     * @return $this
+     * @throws \Zend_Form_Exception
+     */
+    protected function addZoneElements()
+    {
+        $this->addZoneElement(true);
+        $this->addDisplayGroup(['zone_id'], 'clustering', [
+            'decorators' => [
+                'FormElements',
+                ['HtmlTag', ['tag' => 'dl']],
+                'Fieldset',
+            ],
+            'order'  => self::GROUP_ORDER_CLUSTERING,
+            'legend' => $this->translate('Zone settings')
+        ]);
+
+        return $this;
+    }
+}
diff --git a/application/forms/IcingaHostGroupForm.php b/application/forms/IcingaHostGroupForm.php
@@ -2,10 +2,11 @@
 
 namespace Icinga\Module\Director\Forms;
 
-use Icinga\Module\Director\Web\Form\DirectorObjectForm;
-
-class IcingaHostGroupForm extends DirectorObjectForm
+class IcingaHostGroupForm extends IcingaGroupForm
 {
+    /**
+     * @throws \Zend_Form_Exception
+     */
     public function setup()
     {
         $this->addHidden('object_type', 'object');
@@ -22,21 +23,6 @@ public function setup()
              ->setButtons();
     }
 
-    protected function addZoneElements()
-    {
-        $this->addZoneElement(true);
-        $this->addDisplayGroup(['zone_id'], 'clustering', [
-            'decorators' => [
-                'FormElements',
-                ['HtmlTag', ['tag' => 'dl']],
-                'Fieldset',
-            ],
-            'order' => 80,
-            'legend' => $this->translate('Zone settings'),
-        ]);
-        return $this;
-    }
-
     protected function addAssignmentElements()
     {
         $this->addAssignFilter([

diff --git a/application/forms/IcingaServiceGroupForm.php b/application/forms/IcingaServiceGroupForm.php
@@ -2,10 +2,11 @@
 
 namespace Icinga\Module\Director\Forms;
 
-use Icinga\Module\Director\Web\Form\DirectorObjectForm;
-
-class IcingaServiceGroupForm extends DirectorObjectForm
+class IcingaServiceGroupForm extends IcingaGroupForm
 {
+    /**
+     * @throws \Zend_Form_Exception
+     */
     public function setup()
     {
         $this->addHidden('object_type', 'object');
@@ -22,21 +23,6 @@ public function setup()
              ->setButtons();
     }
 
-    protected function addZoneElements()
-    {
-        $this->addZoneElement(true);
-        $this->addDisplayGroup(['zone_id'], 'clustering', [
-            'decorators' => [
-                'FormElements',
-                ['HtmlTag', ['tag' => 'dl']],
-                'Fieldset',
-            ],
-            'order' => 80,
-            'legend' => $this->translate('Zone settings'),
-        ]);
-        return $this;
-    }
-
     protected function addAssignmentElements()
     {
         $this->addAssignFilter([

diff --git a/application/forms/IcingaUserGroupForm.php b/application/forms/IcingaUserGroupForm.php
@@ -2,9 +2,7 @@
 
 namespace Icinga\Module\Director\Forms;
 
-use Icinga\Module\Director\Web\Form\DirectorObjectForm;
-
-class IcingaUserGroupForm extends DirectorObjectForm
+class IcingaUserGroupForm extends IcingaGroupForm
 {
     /**
      * @throws \Zend_Form_Exception
@@ -24,24 +22,4 @@ public function setup()
              ->groupMainProperties()
              ->setButtons();
     }
-
-    /**
-     * @return $this
-     * @throws \Zend_Form_Exception
-     */
-    protected function addZoneElements()
-    {
-        $this->addZoneElement(true);
-        $this->addDisplayGroup(['zone_id'], 'clustering', [
-            'decorators' => [
-                'FormElements',
-                ['HtmlTag', ['tag' => 'dl']],
-                'Fieldset',
-            ],
-            'order'  => self::GROUP_ORDER_CLUSTERING,
-            'legend' => $this->translate('Zone settings')
-        ]);
-
-        return $this;
-    }
 }
diff --git a/library/Director/Objects/IcingaHostGroup.php b/library/Director/Objects/IcingaHostGroup.php
@@ -6,21 +6,6 @@ class IcingaHostGroup extends IcingaObjectGroup
 {
     protected $table = 'icinga_hostgroup';
 
-    protected $defaultProperties = [
-        'id'            => null,
-        'uuid'          => null,
-        'object_name'   => null,
-        'object_type'   => null,
-        'disabled'      => 'n',
-        'display_name'  => null,
-        'assign_filter' => null,
-        'zone_id'       => null,
-    ];
-
-    protected $relations = [
-        'zone' => 'IcingaZone',
-    ];
-
     /** @var HostGroupMembershipResolver */
     protected $hostgroupMembershipResolver;
 

diff --git a/library/Director/Objects/IcingaObjectGroup.php b/library/Director/Objects/IcingaObjectGroup.php
@@ -22,6 +22,11 @@ abstract class IcingaObjectGroup extends IcingaObject implements ExportInterface
         'disabled'      => 'n',
         'display_name'  => null,
         'assign_filter' => null,
+        'zone_id'       => null,
+    ];
+
+    protected $relations = [
+        'zone' => 'IcingaZone',
     ];
 
     public function getUniqueIdentifier()

diff --git a/library/Director/Objects/IcingaServiceGroup.php b/library/Director/Objects/IcingaServiceGroup.php
@@ -6,21 +6,6 @@ class IcingaServiceGroup extends IcingaObjectGroup
 {
     protected $table = 'icinga_servicegroup';
 
-    protected $defaultProperties = [
-        'id'            => null,
-        'uuid'          => null,
-        'object_name'   => null,
-        'object_type'   => null,
-        'disabled'      => 'n',
-        'display_name'  => null,
-        'assign_filter' => null,
-        'zone_id'       => null,
-    ];
-
-    protected $relations = [
-        'zone' => 'IcingaZone',
-    ];
-
     /** @var ServiceGroupMembershipResolver */
     protected $servicegroupMembershipResolver;
 

diff --git a/library/Director/Objects/IcingaUserGroup.php b/library/Director/Objects/IcingaUserGroup.php
@@ -18,10 +18,6 @@ class IcingaUserGroup extends IcingaObjectGroup
         'zone_id'       => null,
     ];
 
-    protected $relations = [
-        'zone' => 'IcingaZone',
-    ];
-
     protected function prefersGlobalZone()
     {
         return false;