New DateTimeFormatter Filter (#3617)

library/Zend/Filter/DateTimeFormatter.php

@@ -0,0 +1,83 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\Filter;
+
+use DateTime;
+use Exception;
+
+class DateTimeFormatter extends AbstractFilter
+{
+    /**
+     * A valid format string accepted by date()
+     *
+     * @var string
+     */
+    protected $format = DateTime::ISO8601;
+
+    /**
+     * Sets filter options
+     *
+     * @param  string|array|\Zend\Config\Config $options
+     */
+    public function __construct($options = null)
+    {
+        if ($options) {
+            $this->setOptions($options);
+        }
+    }
+
+    /**
+     * Set the format string accepted by date() to use when formatting a string
+     *
+     * @param  string $format
+     * @return \Zend\Filter\DateTimeFormatter
+     */
+    public function setFormat($format)
+    {
+        $this->format = $format;
+        return $this;
+    }
+
+    /**
+     * Filter a datetime string by normalizing it to the filters specified format
+     *
+     * @param  string $value
+     * @return string
+     */
+    public function filter($value)
+    {
+        try {
+            $result = $this->normalizeDateTime($value);
+        } catch (Exception $ex) {
+            // DateTime threw an exception, an invalid date string was provided
+            return $value;
+        }
+
+        return $result;
+    }
+
+    /**
+     * Attempt to convert a string into a valid DateTime object
+     *
+     * @param string $value
+     * @returns DateTime
+     * @throws Exception
+     */
+    protected function normalizeDateTime($value)
+    {
+        if (is_int($value)) {
+            $dateTime = new DateTime('@' . $value);
+        } else {
+            $dateTime = new DateTime($value);
+        }
+
+        return $dateTime->format($this->format);
+    }
+}

library/Zend/Form/Element/DateTime.php

@@ -32,9 +32,7 @@ class DateTime extends Element implements InputProviderInterface
     );
 
     /**
-     *
-     * Opera and mobile browsers support datetime input, and display a datepicker control
-     * But the submitted value does not include seconds.
+     * A valid format string accepted by date()
      *
      * @var string
      */
@@ -189,6 +187,12 @@ public function getInputSpecification()
             'required' => true,
             'filters' => array(
                 array('name' => 'Zend\Filter\StringTrim'),
+                array(
+                    'name' => 'Zend\Filter\DateTimeFormatter',
+                    'options' => array(
+                        'format' => $this->getFormat(),
+                    )
+                )
             ),
             'validators' => $this->getValidators(),
         );

library/Zend/Form/Element/DateTimeLocal.php

@@ -9,7 +9,6 @@
 
 namespace Zend\Form\Element;
 
-use Zend\Form\Element;
 use Zend\Validator\DateStep as DateStepValidator;
 
 class DateTimeLocal extends DateTime
@@ -26,11 +25,7 @@ class DateTimeLocal extends DateTime
     );
 
     /**
-     *
-     * Opera and mobile browsers support datetime input, and display a datepicker control
-     * But the submitted value does not include seconds.
-     *
-     * @var string
+     * {@inheritDoc}
      */
     protected $format = self::DATETIME_LOCAL_FORMAT;
 

tests/ZendTest/Filter/DateTimeFormatterTest.php

@@ -0,0 +1,57 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ * @package   Zend_Filter
+ */
+
+namespace ZendTest\Filter;
+
+use DateTime;
+use Zend\Filter\DateTimeFormatter;
+
+/**
+ * @category   Zend
+ * @package    Zend_Filter
+ * @subpackage UnitTests
+ * @group      Zend_Filter
+ */
+class DateTimeFormatterTest extends \PHPUnit_Framework_TestCase
+{
+    public function setUp()
+    {
+        date_default_timezone_set('UTC');
+    }
+
+    public function testDateTimeFormatted()
+    {
+        $filter = new DateTimeFormatter();
+        $result = $filter->filter('2012-01-01');
+        $this->assertEquals('2012-01-01T00:00:00+0000', $result);
+    }
+
+    public function testSetFormat()
+    {
+        $filter = new DateTimeFormatter();
+        $filter->setFormat(DateTime::RFC1036);
+        $result = $filter->filter('2012-01-01');
+        $this->assertEquals('Sun, 01 Jan 12 00:00:00 +0000', $result);
+    }
+
+    public function testFormatDateTimeFromTimestamp()
+    {
+        $filter = new DateTimeFormatter();
+        $result = $filter->filter(1359739801);
+        $this->assertEquals('2013-02-01T17:30:01+0000', $result);
+    }
+
+    public function testOriginalValueReturnedOnInvalidInput()
+    {
+        $filter = new DateTimeFormatter();
+        $result = $filter->filter('2013-31-31');
+        $this->assertEquals('2013-31-31', $result);
+    }
+}

tests/ZendTest/Form/Element/DateTimeTest.php

@@ -58,6 +58,27 @@ public function testProvidesInputSpecificationThatIncludesValidatorsBasedOnAttri
         }
     }
 
+    public function testProvidesInputSpecificationThatIncludesDateTimeFormatterBasedOnAttributes()
+    {
+        $element = new DateTimeElement('foo');
+        $element->setFormat(DateTime::W3C);
+
+        $inputSpec = $element->getInputSpecification();
+        $this->assertArrayHasKey('filters', $inputSpec);
+        $this->assertInternalType('array', $inputSpec['filters']);
+
+        foreach ($inputSpec['filters'] as $filter) {
+            switch ($filter['name']) {
+                case 'Zend\Filter\DateTimeFormatter':
+                    $this->assertEquals($filter['options']['format'], DateTime::W3C);
+                    $this->assertEquals($filter['options']['format'], $element->getFormat());
+                    break;
+                default:
+                    break;
+            }
+        }
+    }
+
     public function testUsesBrowserFormatByDefault()
     {
         $element = new DateTimeElement('foo');