Documentation cleanup, return value fix for Data::clear()

Author: maschmann

Config/ConfigInterface.php

@@ -22,7 +22,7 @@
 interface ConfigInterface extends DataInterface
 {
     /**
-     * add named property to config object
+     * Add named property to config object
      * and insert config as array
      *
      * @param string $name name of property

Config/ConfigTimer.php

@@ -18,7 +18,7 @@
 final class ConfigTimer extends ConfigAbstract implements ConfigInterface
 {
     /**
-     * convert config date strings to \DateTime objects or \DateIntervals
+     * Convert config date strings to \DateTime objects or \DateIntervals.
      *
      * @param string $file config file
      */
@@ -28,20 +28,16 @@ public function setConfig($file)
 
         // iterate conf and check if there are dates/datetimes/times and so on, for conversion
         foreach ($config as $timerKey => $timers) {
-
             switch ($timerKey) {
                 case 'timers':
                     foreach ($timers as $timerSubKey => $params) {
-
                         foreach ($params as $paramKey => $paramVal) {
                             switch ($paramKey) {
                                 case 'interval':
                                     // check the contents of interval
                                     foreach ($paramVal as $intervalKey => $interval) {
-
                                         // convert all sub elements
                                         foreach ($interval as $key => $intervalValue) {
-
                                             // just a date, no time - one element
                                             switch (count($interval)) {
                                                 case 1:
@@ -59,21 +55,17 @@ public function setConfig($file)
                                                         $data;
                                                     break;
                                             }
-
                                         }
                                     }
                                     break;
                                 default:
                                     break;
                             }
                         }
-
                     }
-
                     break;
                 case 'holidays':
                     foreach ($timers as $timerSubKey => $params) {
-
                         foreach ($params as $paramKey => $paramValue) {
                             $config[$timerKey][$timerSubKey] = array(
                                 new \DateTime($paramValue),

Data/Data.php

@@ -27,10 +27,14 @@ class Data implements DataInterface
 
     /**
      * Clears the data(!) content of the object.
+     *
+     * @return $this
      */
     public function clear()
     {
         $this->data = array();
+
+        return $this;
     }
 
     /**

Data/DataInterface.php

@@ -18,12 +18,15 @@
 interface DataInterface
 {
     /**
-     * remove all data from object
+     * Remove all data from internal array.
+     *
+     * @return $this
      */
     public function clear();
 
     /**
-     * generic set method for multidimensional storage
+     * Generic set method for multidimensional storage.
+     *
      * $this->set( $key1, $key2, $key3, ..., $mixVal )
      *
      * @throws \InvalidArgumentException
@@ -32,54 +35,58 @@ public function clear();
     public function set();
 
     /**
-     * set list of key/value pairs via one dimensional array
+     * Add array content by iteration to interal array.
      *
-     * @param  array                     $param
+     * @param  array $param
+     * @return $this
      * @throws \InvalidArgumentException
      */
     public function setByArray(array $param);
 
     /**
-     * adds given object's properties to self
+     * Adds given object's properties to interal array.
      *
-     * @param  object                    $param
+     * @param  object $param
+     * @return $this
      * @throws \InvalidArgumentException
      */
     public function setByObject($param);
 
     /**
-     * fill datastore by json string
+     * Fill datastore by json string.
      *
      * @param string $json
      * @return mixed
      */
     public function setByJson($json);
 
     /**
-     * multidimensional getter
-     * find a key structure in a multidimensional array and return the value
-     * params are stackable -> get( $k1, $k2, $k3, ... )
+     * Multidimensional getter.
+     *
+     * Find a key structure in a multidimensional array and return the value
+     * params are stackable -> get( $k1, $k2, $k3, ... ).
      *
      * @return bool|mixed
      */
     public function get();
 
     /**
-     * remove key from container
+     * Remove key from internal storage.
      *
      * @param string $key
+     * @return $this
      */
     public function remove($key);
 
     /**
-     * gets key index
+     * Get all firstlevel keys of interal array.
      *
      * @return array keylist
      */
     public function getKeys();
 
     /**
-     * return count of all firstlevel elements
+     * Return count of all firstlevel elements.
      *
      * @return int
      */