Merge branch 'master' of github.com:maschmann/php-utilities

Author: maschmann

README.md

@@ -3,4 +3,31 @@ php-utilities
 [![Build Status](https://travis-ci.org/maschmann/php-utilities.png?branch=master)](https://travis-ci.org/maschmann/php-utilities)
 [![phpci build status](http://phpci.br0ken.de/build-status/image/9)](http://phpci.br0ken.de)
 
-php utilities like data container, collection object, timer, ...
+## About
+This library is all about helping with the common little problems like having a type of object to inherit from with an internal data storage to turn to a json or array, ... 
+
+## Usage
+A lot of examples on how to use the classes can be found in the UnitTests. The whole collection is extensively tested and therefore quite stable.
+Feel free to contribute, suggest changes or help make it better.
+
+## Contents
+You'll get following groups of classes which are interdependent
+
+### Data
+This part consists of two distinct classes:
+* Data is a data store where you can easily store and retrieve data.
+* DataCollection ist a container to house items like objects, iterable.
+
+### Config
+Here you get a static factory which is able to produce three types of configuration objects, based on Data class. All config objects take yaml files as source and provide easy access via get/set methods. See UnitTests for examples.
+Available types are:
+* ConfigDefault - basic config object, stores the yaml content "as is", provides get/set.
+* ConfigEnv - provides the possibility to get an environment-merged config. Based on the currently provided env, you'll have e.g. prod -> dev merged, with prod node as a master.
+* ConfigTimer is a specialised for of config to provide pre-generated DateTime objects for the Timer class.
+
+### Timer
+Provides functionality to check if there's a current holiday, has configurable "timers" to check uf e.g. your hotline should be available etc.
+Extensive examples can be found within both, the TestData and UnitTests :-)
+
+### Test
+TestData is just a helper for providing configurations for either Config and Timer. Have a look for YAML config examples.

src/Asm/Config/ConfigTimer.php

@@ -89,7 +89,7 @@ public function setConfig($file)
                     foreach ($timers as $timerSubKey => $params) {
 
                         foreach ($params as $paramKey => $paramValue) {
-                            $config[$timerKey][$timerSubKey][$paramKey] = array(
+                            $config[$timerKey][$timerSubKey] = array(
                                 new \DateTime($paramValue),
                                 new \DateTime($paramValue . ' 23:59:59'),
                             );

src/Asm/Test/TestData.php

@@ -62,11 +62,19 @@ public static function getYamlTimerConfigFile()
     example_timer_config_3:
         day:                [ monday, tuesday, wednesday, thursday ] # works weekdays 00:00:00 - 23:59:59
 
+    example_timer_config_3.1:
+        day:                [ monday, tuesday, wednesday, thursday, friday, saturday, sunday ]
+
     example_timer_config_4:
         day:                [ monday ]                  # works only mondays
         time:
             - [ "01:05:00", "17:00:00" ]  # from 01:05:00 to 17:00:00
 
+    example_timer_config_4.1:
+        day:                [ monday, tuesday, wednesday, thursday, friday, saturday, sunday ]
+        time:
+            - [ "01:05:00", "17:00:00" ]  # from 01:05:00 to 17:00:00
+
     example_timer_config_5:
         time:
             - [ "01:05:00", "17:00:00" ]  # from 01:05:00 to 17:00:00
@@ -75,15 +83,24 @@ public static function getYamlTimerConfigFile()
         holiday:
             use_gerneral:   true                        # if false, uses separate holidays conf
             additional:     [ sub, 1 ]                  # add or subract n days to holiday to create range
-            interval:
-                - [ "16:00:00", "16:00:00" ]  # start and end time
+
+    example_timer_config_7:
+        holiday:
+            use_gerneral:   true                        # if false, uses separate holidays conf
+            additional:     [ sub, 1 ]                  # add or subract n days to holiday to create range
+            interval: [ "16:00:00", "16:00:00" ]  # start and end time
+
+    example_timer_config_7.1:
+        holiday:
+            use_gerneral:   true
+            additional:     [ add, 1 ]
+            interval: [ "16:00:00", "16:00:00" ]  # start and end time
 
     general_shipping_promise:
         holiday:
             use_general:    true
             additional:     [ sub, 1 ]                  # add or subract n days to holiday to create range
-            interval:
-                - [ "16:00:00", "16:00:00" ]  # start and end time
+            interval: [ "16:00:00", "16:00:00" ]  # start and end time
         day:                [ monday, tuesday, wednesday, thursday, friday, sunday  ]
 
     shipping_promise_sunday:

src/Asm/Tests/Timer/TimerTest.php

@@ -50,17 +50,22 @@ public function testConstruct()
      * @covers \Asm\Timer\Timer::checkDays
      * @covers \Asm\Timer\Timer::checkTime
      * @covers \Asm\Timer\Timer::checkHoliday
+     * @covers \Asm\Timer\Timer::flush
      * @param Timer $timer
      */
     public function testIsTimerActive(Timer $timer)
     {
         $this->assertTrue(is_bool($timer->isTimerActive('example_timer_config_1')));
         $this->assertTrue(is_bool($timer->isTimerActive('example_timer_config_2')));
         $this->assertTrue(is_bool($timer->isTimerActive('example_timer_config_3')));
+        $this->assertTrue(is_bool($timer->isTimerActive('example_timer_config_3.1')));
         $this->assertTrue(is_bool($timer->isTimerActive('example_timer_config_4')));
+        $this->assertTrue(is_bool($timer->isTimerActive('example_timer_config_4.1')));
         $this->assertTrue(is_bool($timer->isTimerActive('example_timer_config_5')));
-        //$this->assertTrue(is_bool($timer->isTimerActive('example_timer_config_6')));
-        //$this->assertTrue(is_bool($timer->isTimerActive('general_shipping_promise')));
+        $this->assertTrue(is_bool($timer->isTimerActive('example_timer_config_6')));
+        $this->assertTrue(is_bool($timer->isTimerActive('example_timer_config_7')));
+        $this->assertTrue(is_bool($timer->isTimerActive('example_timer_config_7.1')));
+        $this->assertTrue(is_bool($timer->isTimerActive('general_shipping_promise')));
     }
 
     /**
@@ -71,8 +76,8 @@ public function testIsTimerActive(Timer $timer)
      */
     public function testIsHoliday(Timer $timer)
     {
-        $this->assertFalse($timer->isHoliday('2014-03-03 00:00:00'));
-        $this->assertTrue($timer->isHoliday('2014-12-24 12:30:01'));
-        $this->assertTrue(is_bool($timer->isHoliday()));
+        $this->assertFalse($timer->isHoliday('2014-03-03 00:00:00'), 'failed to check non-holiday date');
+        $this->assertTrue($timer->isHoliday('2014-12-24 12:30:01'), 'failed to validate christmas');
+        $this->assertTrue(is_bool($timer->isHoliday()), 'failed to validate bool return');
     }
 }

src/Asm/Timer/Timer.php

@@ -80,6 +80,7 @@ public function isTimerActive($type)
             $return = $this->checkDate();
         }
 
+        $this->flush();
         return $return;
     }
 
@@ -105,6 +106,15 @@ public function getHoliday()
         return $this->holiday;
     }
 
+    /**
+     * clear current configuration
+     */
+    public function flush()
+    {
+        $this->currentConf = array();
+        $this->holiday = null;
+    }
+
     /**
      * date checks on config
      *
@@ -223,11 +233,6 @@ private function checkIntervals(array $intervals = array())
         }
 
         foreach ($intervals as $interval) {
-            // this means: just some time
-            if (!is_a($interval[0], 'DateTime') || !is_a($interval[1], 'DateTime')) {
-                $interval = $this->checkTime($intervals);
-            }
-
             $intervalStart = $today->diff($interval[0]);
             $intervalEnd = $today->diff($interval[1]);