Timestamp log filter

library/Zend/Log/Filter/Timestamp.php

@@ -0,0 +1,91 @@
+<?php
+namespace Zend\Log\Filter;
+
+use Zend\Log\Exception;
+use DateTime;
+
+/**
+ * Filters log events based on the time when they were triggered.
+ *
+ * @author Nikola Posa <posa.nikola@gmail.com>
+ */
+class Timestamp implements FilterInterface
+{
+    /**
+     * DateTime instance or desired value based on $dateFormatChar.
+     *
+     * @var int|DateTime
+     */
+    protected $value;
+
+    /**
+     * PHP idate()-compliant format character.
+     *
+     * @var string|null
+     */
+    protected $dateFormatChar = null;
+
+    /**
+     * @var string
+     */
+    protected $operator;
+
+    /**
+     * @param int|DateTime|array|Traversable $value DateTime instance or desired value based on $dateFormatChar
+     * @param string $dateFormatChar PHP idate()-compliant format character
+     * @param string $operator Comparison operator
+     * @return Timestamp
+     * @throws Exception\InvalidArgumentException
+     */
+    public function __construct($value, $dateFormatChar = null, $operator = null)
+    {
+        if ($value instanceof Traversable) {
+            $value = iterator_to_array($value);
+        }
+        if (is_array($value)) {
+            extract($value, EXTR_IF_EXISTS);
+        }
+
+        if ($value instanceof DateTime) {
+            $this->value = $value;
+        } else {
+            if (!is_int($value)) {
+                throw new Exception\InvalidArgumentException(sprintf(
+                    'Value must be either DateTime instance or integer; received "%s"',
+                    gettype($value)
+                ));
+            } elseif (!is_string($dateFormatChar)) {
+                throw new Exception\InvalidArgumentException(sprintf(
+                    'Date format character must be supplied as string; received "%s"',
+                    gettype($dateFormatChar)
+                ));
+            }
+            $this->value = $value;
+            $this->dateFormatChar = $dateFormatChar;
+        }
+
+        $this->operator = ($operator) ?: '<=';
+    }
+
+    /**
+     * Returns TRUE if timestamp is accepted, otherwise FALSE is returned.
+     *
+     * @param array $event event data
+     * @return bool
+     */
+    public function filter(array $event)
+    {
+        $datetime = $event['timestamp'];
+        $timestamp = $datetime->getTimestamp();
+
+        if ($this->value instanceof DateTime) {
+            return version_compare((string) $timestamp, (string) $this->value->getTimestamp(), $this->operator);
+        } else {
+            return version_compare(
+                idate($this->dateFormatChar, $timestamp),
+                $this->value,
+                $this->operator
+            );
+        }
+    }
+}

tests/ZendTest/Log/Filter/TimestampTest.php

@@ -0,0 +1,99 @@
+<?php
+namespace ZendTest\Log\Filter;
+
+use PHPUnit_Framework_TestCase as TestCase;
+use Zend\Log\Filter\Timestamp as TimestampFilter;
+
+/**
+ * @group Zend_Log
+ *
+ * @author Nikola Posa <posa.nikola@gmail.com>
+ */
+class TimestampTest extends TestCase
+{
+    /**
+     * @dataProvider dateTimeDataProvider
+     */
+    public function testComparisonWhenValueIsSuppliedAsDateTimeObject($timestamp, $dateTimeValue, $operator, $expectation)
+    {
+        $filter = new TimestampFilter($dateTimeValue, null, $operator);
+
+        $result = $filter->filter(array('timestamp' => $timestamp));
+
+        if ($expectation === true) {
+            $this->assertTrue($result);
+        } else {
+            $this->assertFalse($result);
+        }
+    }
+
+    public function dateTimeDataProvider()
+    {
+        return array(
+            array(new \DateTime('2014-03-03'), new \DateTime('2014-03-03'), '>=', true),
+            array(new \DateTime('2014-10-10'), new \DateTime('2014-03-03'),'>=', true),
+            array(new \DateTime('2013-03-03'), new \DateTime('2014-03-03'), '>=', false),
+            array(new \DateTime('2014-03-03'), new \DateTime('2014-03-03'), '==', true),
+            array(new \DateTime('2014-02-02'), new \DateTime('2014-03-03'), '<', true),
+            array(new \DateTime('2014-03-03'), new \DateTime('2014-03-03'), '<', false)
+        );
+    }
+
+    /**
+     * @dataProvider datePartDataProvider
+     */
+    public function testComparisonWhenValueIsSuppliedAsDatePartValue($timestamp, $datePartVal, $datePartChar, $operator, $expectation)
+    {
+        $filter = new TimestampFilter($datePartVal, $datePartChar, $operator);
+
+        $result = $filter->filter(array('timestamp' => $timestamp));
+
+        if ($expectation === true) {
+            $this->assertTrue($result);
+        } else {
+            $this->assertFalse($result);
+        }
+    }
+
+    public function datePartDataProvider()
+    {
+        return array(
+            array(new \DateTime('2014-03-03 10:15:00'), 10, 'H', '==', true),
+            array(new \DateTime('2013-03-03 22:00:00'), 10, 'H', '==', false),
+            array(new \DateTime('2014-03-04 10:15:00'), 3, 'd', '>', true),
+            array(new \DateTime('2014-03-04 10:15:00'), 10, 'd', '<', true),
+            array(new \DateTime('2014-03-03 10:15:00'), 1, 'm', '==', false),
+            array(new \DateTime('2014-03-03 10:15:00'), 2, 'm', '>=', true),
+        );
+    }
+
+    /**
+     * @expectedException Zend\Log\Exception\InvalidArgumentException
+     */
+    public function testConstructorThrowsOnInvalidValue()
+    {
+        new TimestampFilter('foo');
+    }
+
+    /**
+     * @expectedException Zend\Log\Exception\InvalidArgumentException
+     */
+    public function testConstructorThrowsWhenDateFormatCharIsMissing()
+    {
+        new TimestampFilter(3);
+    }
+
+    public function testFilterCreatedFromArray()
+    {
+        $config = array(
+            'value' => 10,
+            'dateFormatChar' => 'm',
+            'operator' => '==',
+        );
+        $filter = new TimestampFilter($config);
+
+        $this->assertAttributeEquals($config['value'], 'value', $filter);
+        $this->assertAttributeEquals($config['dateFormatChar'], 'dateFormatChar', $filter);
+        $this->assertAttributeEquals($config['operator'], 'operator', $filter);
+    }
+}