Add docstrings to ObjectList and coding style

Icinga · Apr 7, 2015 · 46da404 · 46da404
1 parent 1c5a091
commit 46da404
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 2 deletions.
diff --git a/library/Icinga/Protocol/Ldap/Capability.php b/library/Icinga/Protocol/Ldap/Capability.php
@@ -9,7 +9,8 @@
  * Provides information about the available encryption mechanisms (StartTLS), the supported
  * LDAP protocol (v2/v3), vendor-specific extensions or protocols controls and extensions.
  */
-class Capability {
+class Capability
+{
 
     const LDAP_SERVER_START_TLS_OID = '1.3.6.1.4.1.1466.20037';
 

diff --git a/library/Icinga/Util/Color.php b/library/Icinga/Util/Color.php
@@ -6,7 +6,8 @@
 /**
  * Provide functions to change and convert colors.
  */
-class Color {
+class Color
+{
     /**
      * Convert a given color string to an rgb-array containing
      * each color as a decimal value.

diff --git a/modules/monitoring/library/Monitoring/Object/ObjectList.php b/modules/monitoring/library/Monitoring/Object/ObjectList.php
@@ -5,52 +5,90 @@
 
 use ArrayIterator;
 use Countable;
+use Icinga\Data\Filter\Filter;
 use IteratorAggregate;
 use Icinga\Module\Monitoring\Backend\MonitoringBackend;
 
 abstract class ObjectList implements Countable, IteratorAggregate
 {
+    /**
+     * @var string
+     */
     protected $dataViewName;
 
+    /**
+     * @var MonitoringBackend
+     */
     protected $backend;
 
+    /**
+     * @var array
+     */
     protected $columns;
 
+    /**
+     * @var Filter
+     */
     protected $filter;
 
+    /**
+     * @var array
+     */
     protected $objects;
 
+    /**
+     * @var int
+     */
     protected $count;
 
     public function __construct(MonitoringBackend $backend)
     {
         $this->backend = $backend;
     }
 
+    /**
+     * @param array $columns
+     *
+     * @return $this
+     */
     public function setColumns(array $columns)
     {
         $this->columns = $columns;
         return $this;
     }
 
+    /**
+     * @return array
+     */
     public function getColumns()
     {
         return $this->columns;
     }
 
+    /**
+     * @param $filter
+     *
+     * @return $this
+     */
     public function setFilter($filter)
     {
         $this->filter = $filter;
         return $this;
     }
 
+    /**
+     * @return Filter
+     */
     public function getFilter()
     {
         return $this->filter;
     }
 
     abstract protected function fetchObjects();
 
+    /**
+     * @return array
+     */
     public function fetch()
     {
         if ($this->objects === null) {
@@ -59,6 +97,9 @@ public function fetch()
         return $this->objects;
     }
 
+    /**
+     * @return int
+     */
     public function count()
     {
         if ($this->count === null) {
@@ -86,6 +127,9 @@ public function getComments()
         return $this->backend->select()->from('comment')->applyFilter($this->filter);
     }
 
+    /**
+     * @return ObjectList
+     */
     public function getAcknowledgedObjects()
     {
         $acknowledgedObjects = array();
@@ -97,6 +141,9 @@ public function getAcknowledgedObjects()
         return $this->newFromArray($acknowledgedObjects);
     }
 
+    /**
+     * @return ObjectList
+     */
     public function getObjectsInDowntime()
     {
         $objectsInDowntime = array();
@@ -108,6 +155,9 @@ public function getObjectsInDowntime()
         return $this->newFromArray($objectsInDowntime);
     }
 
+    /**
+     * @return ObjectList
+     */
     public function getUnhandledObjects()
     {
         $unhandledObjects = array();
@@ -148,5 +198,8 @@ protected function newFromArray(array $objects)
         return $list;
     }
 
+    /**
+     * @return Filter
+     */
     abstract function filterFromResult();
 }