From 4c1ab4dae627d93938358ae178bb2bcfbd494dfe Mon Sep 17 00:00:00 2001
From: Thomas Gelf <thomas@gelf.net>
Date: Tue, 13 Dec 2016 18:24:11 +0100
Subject: [PATCH] php: just some comments and cleanup

---
 application/forms/IcingaServiceForm.php       | 20 +++++++++++++------
 .../Director/Objects/DirectorDatafield.php    | 13 ++++--------
 .../Web/Form/IcingaObjectFieldLoader.php      | 14 +++++++++----
 3 files changed, 28 insertions(+), 19 deletions(-)

diff --git a/application/forms/IcingaServiceForm.php b/application/forms/IcingaServiceForm.php
index d4aabf68..8b7ca72d 100644
--- a/application/forms/IcingaServiceForm.php
+++ b/application/forms/IcingaServiceForm.php
@@ -11,12 +11,16 @@ use Icinga\Module\Director\Objects\IcingaServiceSet;
 
 class IcingaServiceForm extends DirectorObjectForm
 {
+    /** @var IcingaHost */
     private $host;
 
     private $set;
 
     private $apply;
 
+    /** @var IcingaService */
+    protected $object;
+
     private $hostGenerated = false;
 
     private $inheritedFrom;
@@ -36,15 +40,18 @@ class IcingaServiceForm extends DirectorObjectForm
     public function setup()
     {
         if ($this->object && $this->object->usesVarOverrides()) {
-            return $this->setupForVarOverrides();
+            $this->setupForVarOverrides();
+            return;
         }
 
         if ($this->hostGenerated) {
-            return $this->setupHostGenerated();
+            $this->setupHostGenerated();
+            return;
         }
 
         if ($this->inheritedFrom) {
-            return $this->setupInherited();
+            $this->setupInherited();
+            return;
         }
 
         try {
@@ -186,7 +193,8 @@ class IcingaServiceForm extends DirectorObjectForm
         }
 
         if ($this->isNew() && empty($imports)) {
-            return $this->groupMainProperties();
+            $this->groupMainProperties();
+            return;
         }
 
         $this->addNameElement()
@@ -223,7 +231,8 @@ class IcingaServiceForm extends DirectorObjectForm
         }
 
         if ($this->isNew() && empty($imports)) {
-            return $this->groupMainProperties();
+            $this->groupMainProperties();
+            return;
         }
 
         $this->addNameElement()
@@ -384,7 +393,6 @@ class IcingaServiceForm extends DirectorObjectForm
 
     protected function succeedForOverrides()
     {
-
         $vars = array();
         foreach ($this->object->vars() as $key => $var) {
             $vars[$key] = $var->getValue();
diff --git a/library/Director/Objects/DirectorDatafield.php b/library/Director/Objects/DirectorDatafield.php
index bd23f4fc..5764bffc 100644
--- a/library/Director/Objects/DirectorDatafield.php
+++ b/library/Director/Objects/DirectorDatafield.php
@@ -76,10 +76,10 @@ class DirectorDatafield extends DbObjectWithSettings
             return $el;
         }
 
-        /** @var DataTypeHook $datatype */
-        $datatype = new $className;
-        $datatype->setSettings($this->getSettings());
-        $el = $datatype->getFormElement($name, $form);
+        /** @var DataTypeHook $dataType */
+        $dataType = new $className;
+        $dataType->setSettings($this->getSettings());
+        $el = $dataType->getFormElement($name, $form);
 
         if ($this->getSetting('is_required') === 'y') {
             $el->setRequired(true);
@@ -112,11 +112,6 @@ class DirectorDatafield extends DbObjectWithSettings
                 $object->getInheritedVar($varname),
                 $object->getOriginForVar($varname)
             );
-
-        } else {
-            if ($this->required) {
-                $el->setRequired(true);
-            }
         }
     }
 }
diff --git a/library/Director/Web/Form/IcingaObjectFieldLoader.php b/library/Director/Web/Form/IcingaObjectFieldLoader.php
index 6ca16e07..9e6d5858 100644
--- a/library/Director/Web/Form/IcingaObjectFieldLoader.php
+++ b/library/Director/Web/Form/IcingaObjectFieldLoader.php
@@ -65,7 +65,7 @@ class IcingaObjectFieldLoader
      * Works in a failsafe way, when a field does not exist the value will be
      * silently ignored
      *
-     * @param Array  $values key/value pairs with variable names and their value
+     * @param array  $values key/value pairs with variable names and their value
      * @param String $prefix An optional prefix that would be stripped from keys
      *
      * @return self
@@ -76,13 +76,15 @@ class IcingaObjectFieldLoader
             return $this;
         }
 
-        if ($prefix !== null) {
+        if ($prefix === null) {
+            $len = null;
+        } else {
             $len = strlen($prefix);
         }
         $vars = $this->object->vars();
 
         foreach ($values as $key => $value) {
-            if ($prefix) {
+            if ($len !== null) {
                 if (substr($key, 0, $len) === $prefix) {
                     $key = substr($key, $len);
                 } else {
@@ -172,8 +174,10 @@ class IcingaObjectFieldLoader
      * Attach our form fields to the given form
      *
      * This will also create a 'Custom properties' display group
+     *
+     * @param DirectorObjectForm $form
      */
-    protected function attachFieldsToForm(QuickForm $form)
+    protected function attachFieldsToForm(DirectorObjectForm $form)
     {
         $elements = $this->getElements($form);
         foreach ($elements as $element) {
@@ -217,6 +221,8 @@ class IcingaObjectFieldLoader
     /**
      * Get the form elements based on the given form
      *
+     * @param QuickForm $form
+     *
      * @return ZfElement[]
      */
     protected function createElements(QuickForm $form)