Merge pull request zendframework/zendframework#7277 from carnage/date…

…-select-filter

Date select filter

src/AbstractDateDropdown.php

@@ -0,0 +1,132 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\Filter;
+
+/**
+ * Class AbstractDateDropdown
+ * @package Zend\Filter
+ */
+abstract class AbstractDateDropdown extends AbstractFilter
+{
+    /**
+     * If true, the filter will return null if any date field is empty
+     *
+     * @var bool
+     */
+    protected $nullOnEmpty = false;
+
+    /**
+     * If true, the filter will return null if all date fields are empty
+     *
+     * @var bool
+     */
+    protected $nullOnAllEmpty = false;
+
+    /**
+     * Sprintf format string to use for formatting the date, fields will be used in alphabetical order.
+     *
+     * @var string
+     */
+    protected $format = '';
+
+    /**
+     * @var int
+     */
+    protected $expectedInputs;
+
+    /**
+     * @param boolean $nullOnAllEmpty
+     * @return $this
+     */
+    public function setNullOnAllEmpty($nullOnAllEmpty)
+    {
+        $this->nullOnAllEmpty = $nullOnAllEmpty;
+        return $this;
+    }
+
+    /**
+     * @return boolean
+     */
+    public function nullOnAllEmpty()
+    {
+        return $this->nullOnAllEmpty;
+    }
+
+    /**
+     * @param boolean $nullOnEmpty
+     * @return $this
+     */
+    public function setNullOnEmpty($nullOnEmpty)
+    {
+        $this->nullOnEmpty = $nullOnEmpty;
+        return $this;
+    }
+
+    /**
+     * @return boolean
+     */
+    public function nullOnEmpty()
+    {
+        return $this->nullOnEmpty;
+    }
+
+    /**
+     * Returns the result of filtering $value
+     *
+     * @param  mixed $value
+     * @throws Exception\RuntimeException If filtering $value is impossible
+     * @return mixed
+     */
+    public function filter($value)
+    {
+        // Convert the date to a specific format
+        if (is_array($value)) {
+            if (
+                $this->nullOnEmpty() &&
+                array_reduce($value, function ($soFar, $value) { return $soFar | empty($value); }, false)
+            ) {
+                return;
+            }
+
+            if (
+                $this->nullOnAllEmpty() &&
+                array_reduce($value, function ($soFar, $value) { return $soFar & empty($value); }, true)
+            ) {
+                return;
+            }
+
+            $this->filterable($value);
+
+            ksort($value);
+            $value = vsprintf($this->format, $value);
+        }
+
+        return $value;
+    }
+
+    /**
+     * Ensures there are enough inputs in the array to properly format the date.
+     *
+     * @param $value
+     * @throws Exception\RuntimeException
+     */
+    protected function filterable($value)
+    {
+        if (count($value) !== $this->expectedInputs) {
+            throw new Exception\RuntimeException(
+                sprintf(
+                    'There are not enough values in the array to filter this date (Required: %d, Received: %d)',
+                    $this->expectedInputs,
+                    count($value)
+                )
+            );
+        }
+    }
+}

src/DateSelect.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\Filter;
+
+/**
+ * Class DateSelect
+ * @package Zend\Filter
+ */
+class DateSelect extends AbstractDateDropdown
+{
+    /**
+     * Year-Month-Day
+     *
+     * @var string
+     */
+    protected $format = '%3$s-%2$s-%1$s';
+
+    /**
+     * @var int
+     */
+    protected $expectedInputs = 3;
+}

src/DateTimeSelect.php

@@ -0,0 +1,76 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\Filter;
+
+/**
+ * Class DateTimeSelect
+ * @package Zend\Filter
+ */
+class DateTimeSelect extends AbstractDateDropdown
+{
+    /**
+     * Year-Month-Day Hour:Min:Sec
+     *
+     * @var string
+     */
+    protected $format = '%6$s-%4$s-%1$s %2$s:%3$s:%5$s';
+
+    /**
+     * @var int
+     */
+    protected $expectedInputs = 6;
+
+    /**
+     * @param mixed $value
+     * @throws Exception\RuntimeException
+     * @return array|mixed|null|string
+     */
+    public function filter($value)
+    {
+        if (is_array($value)) {
+            if ($this->nullOnEmpty() && (
+                    empty($value['year']) ||
+                    empty($value['month']) ||
+                    empty($value['day']) ||
+                    empty($value['hour']) ||
+                    empty($value['minute']) ||
+                    (isset($value['second']) && empty($value['second']))
+                )
+            ) {
+                return;
+            }
+
+            if ($this->nullOnAllEmpty() && (
+                    empty($value['year']) &&
+                    empty($value['month']) &&
+                    empty($value['day']) &&
+                    empty($value['hour']) &&
+                    empty($value['minute']) &&
+                    (!isset($value['second']) || empty($value['second']))
+
+                )
+            ) {
+                return;
+            }
+
+            if (!isset($value['second'])) {
+                $value['second'] = '00';
+            }
+
+            $this->filterable($value);
+
+            ksort($value);
+
+            $value = vsprintf($this->format, $value);
+        }
+
+        return $value;
+    }
+}

src/FilterPluginManager.php

@@ -51,6 +51,8 @@ class FilterPluginManager extends AbstractPluginManager
         'compresszip'                => 'Zend\Filter\Compress\Zip',
         'dataunitformatter'          => 'Zend\Filter\DataUnitFormatter',
         'datetimeformatter'          => 'Zend\Filter\DateTimeFormatter',
+        'dateselect'                 => 'Zend\Filter\DateSelect',
+        'datetimeselect'             => 'Zend\Filter\DateTimeSelect',
         'decompress'                 => 'Zend\Filter\Decompress',
         'decrypt'                    => 'Zend\Filter\Decrypt',
         'digits'                     => 'Zend\Filter\Digits',
@@ -67,6 +69,7 @@ class FilterPluginManager extends AbstractPluginManager
         'htmlentities'               => 'Zend\Filter\HtmlEntities',
         'inflector'                  => 'Zend\Filter\Inflector',
         'int'                        => 'Zend\Filter\Int',
+        'monthselect'                => 'Zend\Filter\MonthSelect',
         'null'                       => 'Zend\Filter\Null',
         'numberformat'               => 'Zend\I18n\Filter\NumberFormat',
         'numberparse'                => 'Zend\I18n\Filter\NumberParse',

src/MonthSelect.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\Filter;
+
+/**
+ * Class MonthSelect
+ * @package Zend\Filter
+ */
+class MonthSelect extends AbstractDateDropdown
+{
+    /**
+     * Year-Month
+     *
+     * @var string
+     */
+    protected $format = '%2$s-%1$s';
+
+    /**
+     * @var int
+     */
+    protected $expectedInputs = 2;
+}

test/DateSelectTest.php

@@ -0,0 +1,49 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace ZendTest\Filter;
+
+use Zend\Filter\DateSelect as DateSelectFilter;
+
+/**
+ * @group      Zend_Filter
+ */
+class DateSelectTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @dataProvider provideFilter
+     * @param $options
+     * @param $input
+     * @param $expected
+     */
+    public function testFilter($options, $input, $expected)
+    {
+        $sut = new DateSelectFilter();
+        $sut->setOptions($options);
+        $this->assertEquals($expected, $sut->filter($input));
+    }
+
+    public function provideFilter()
+    {
+        return array(
+            array(array(), array('year' => '2014', 'month' => '10', 'day' => '26'), '2014-10-26'),
+            array(array('nullOnEmpty' => true), array('year' => null, 'month' => '10', 'day' => '26'), null),
+            array(array('nullOnAllEmpty' => true), array('year' => null, 'month' => null, 'day' => null), null),
+        );
+    }
+
+    /**
+     * @expectedException \Zend\Filter\Exception\RuntimeException
+     */
+    public function testInvalidInput()
+    {
+        $sut = new DateSelectFilter();
+        $sut->filter(array('year' => '2120', 'month' => '07'));
+    }
+}

test/DateTimeSelectTest.php

@@ -0,0 +1,61 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace ZendTest\Filter;
+
+use Zend\Filter\DateTimeSelect as DateTimeSelectFilter;
+
+/**
+ * @group      Zend_Filter
+ */
+class DateTimeSelectTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @dataProvider provideFilter
+     * @param $options
+     * @param $input
+     * @param $expected
+     */
+    public function testFilter($options, $input, $expected)
+    {
+        $sut = new DateTimeSelectFilter();
+        $sut->setOptions($options);
+        $this->assertEquals($expected, $sut->filter($input));
+    }
+
+    public function provideFilter()
+    {
+        return array(
+            array(
+                array(),
+                array('year' => '2014', 'month' => '10', 'day' => '26', 'hour' => '12', 'minute' => '35'),
+                '2014-10-26 12:35:00'
+            ),
+            array(
+                array('nullOnEmpty' => true),
+                array('year' => null, 'month' => '10', 'day' => '26', 'hour' => '12', 'minute' => '35'),
+                null
+            ),
+            array(
+                array('nullOnAllEmpty' => true),
+                array('year' => null, 'month' => null, 'day' => null, 'hour' => null, 'minute' => null),
+                null
+            ),
+        );
+    }
+
+    /**
+     * @expectedException \Zend\Filter\Exception\RuntimeException
+     */
+    public function testInvalidInput()
+    {
+        $sut = new DateTimeSelectFilter();
+        $sut->filter(array('year' => '2120', 'month' => '10', 'day' => '26', 'hour' => '12'));
+    }
+}