New DateTimeFormatter Filter (#3617) #3632

davidwindell · 2013-01-31T13:03:09Z

This PR introduces a simple DateTimeFormatter Filter class that will attempt to format a provided string using the specified date() style format.

The main advantage of this is to allow pre-formatting of a provided datetime value on a Zend\Form\Element\DateTime where the HTML5 spec and different browsers may pass values with or without seconds which can cause the validator to fail.

See #3617

samsonasik · 2013-01-31T14:52:02Z

library/Zend/Filter/DateTimeNormalize.php

+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)


2005-2013 :D

marc-mabe · 2013-01-31T14:59:41Z

Changing the default format for Zend\Form should be done within a seperate PR and btw. removing the const is a BC break.

In my opinion the name should be DateTimeFormatter

Maks3w · 2013-01-31T22:59:58Z

Where are the tests? ;)

Maks3w · 2013-01-31T23:00:39Z

library/Zend/Form/Element/DateTime.php

     *
     * @var string
     */
-    protected $format = self::DATETIME_FORMAT;
+    protected $format = PhpDateTime::W3C;


This is a BC Break

davidwindell · 2013-02-01T17:47:03Z

@Maks3w tests attached

Maks3w · 2013-02-01T18:56:28Z

library/Zend/Filter/DateTimeFormatter.php

+    /**
+     * Sets filter options
+     *
+     * @param  string|array|\Zend\Config\Config $options


* @param array|Traversable $options

Maks3w · 2013-02-01T18:59:18Z

@weierophinney What do you thing about this?

Freeaqingme · 2013-03-06T21:47:20Z

library/Zend/Filter/DateTimeFormatter.php

+namespace Zend\Filter;
+
+use DateTime;
+use Exception;


Can you please use an exception that is part of the Zend\Filter component? If no suitable exception exists you could create it, and have it extend the appropriate SPL exception.

I second the recommendation from @Freeaqingme

Hi both, I am "using" \Exception to catch the Exception thrown by DateTime (http://www.php.net/manual/en/datetime.construct.php) which is just \Exception. Are you saying I should create an Exception in Filter\Exception that Extends \Exception?

In this case, I'd remove the import, and use FQCN when catching:

catch (\Exception $e)

This will make it more clear that you actually intend to catch a global exception -- which is a rare occurrence in the framework.

weierophinney · 2013-03-11T17:36:14Z

This looks good. @davidwindell - Make the changes requested, remove the "[WIP]" notation, and I'll do final review for merge.

davidwindell · 2013-03-13T07:02:52Z

Thanks @weierophinney, I've made the requested changes.

marc-mabe · 2013-03-13T09:06:23Z

library/Zend/Filter/DateTimeFormatter.php

+            $result = $this->normalizeDateTime($value);
+        } catch (\Exception $ex) {
+            // DateTime threw an exception, an invalid date string was provided
+            return $value;


The filter should throw the exception else it returns not normalized dates

$filter->filter('now'); // 2013-03-13 10:00 $filter->filter('2013-03-13 10:00'); // 2013-03-13 10:00 $filter->filter('abcdefg'); // abcdefg ? -> please throw an Exception

@marc-mabe this is not the behaviour of other filters, see https://github.com/zendframework/zf2/blob/master/library/Zend/Filter/UriNormalize.php#L105

Filters should not throw exceptions or they will cause problems with InputFilters

Thats interesting because other filters throw exceptions - see https://github.com/zendframework/zf2/blob/master/library/Zend/Filter/HtmlEntities.php

@weierophinney What's the right way to go here? For me a filter should throw exceptions on failures else it's impossible to detect such failures (see my example above). Only implementations of Zend\Validator\ValidatorInterface::isValid shouldn't throw exceptions but the filters should do that.

I'm now re throwing the blanket DateTime \Exception as a InvalidArgumentException

marc-mabe · 2013-03-21T09:30:08Z

library/Zend/Filter/DateTimeFormatter.php

+            $result = $this->normalizeDateTime($value);
+        } catch (\Exception $ex) {
+            // DateTime threw an exception, an invalid date string was provided
+            throw new Exception\InvalidArgumentException($ex);


This should be throw new Exception\InvalidArgumentException("Invalid input date '{$value}'", 0, $ex); to throw the exception of DateTime as previous exception

New DateTimeFormatter Filter (#3617)

@marc-mabe

- Incorporate feedback from @marc-mabe - Also: use $e as exception (for consistency)

Close #3632

weierophinney · 2013-03-25T14:10:58Z

Merged.

…-unaware-of-datetime-formatter Add service definition for DateTimeFormatter (related to #3632)

…/zf3617 New DateTimeFormatter Filter (zendframework/zendframework#3617)

@marc-mabe

- Incorporate feedback from @marc-mabe - Also: use $e as exception (for consistency)

Close zendframework/zendframework#3632

…otfix/filter-plugin-manager-unaware-of-datetime-formatter Add service definition for DateTimeFormatter (related to zendframework/zendframework#3632)

davidwindell added 2 commits January 31, 2013 12:53

Added DateTimeNormalizer, use W3C format for DateTime Form elements

668c84a

Remove unused use statement

c41ec21

samsonasik reviewed Jan 31, 2013
View reviewed changes

Implement feedback

ebca3f6

Maks3w reviewed Jan 31, 2013
View reviewed changes

davidwindell added 2 commits January 31, 2013 23:29

Fixes

e81ba2e

Added some tests

81ec65f

Maks3w reviewed Feb 1, 2013
View reviewed changes

ghost assigned weierophinney Feb 15, 2013

Updated docbloc

1f9de5d

Freeaqingme reviewed Mar 6, 2013
View reviewed changes

Further feedback

a2a7712

marc-mabe reviewed Mar 13, 2013
View reviewed changes

Added check for DateTime value

90b0456

Update tests for Exception

bef553b

marc-mabe reviewed Mar 21, 2013
View reviewed changes

weierophinney added a commit that referenced this pull request Mar 25, 2013

Merge pull request #3632 from davidwindell/zf3617

cdfd752

New DateTimeFormatter Filter (#3617)

weierophinney added a commit that referenced this pull request Mar 25, 2013

[#3632] throw previous exception

794ab09

- Incorporate feedback from @marc-mabe - Also: use $e as exception (for consistency)

weierophinney added a commit that referenced this pull request Mar 25, 2013

Merge branch 'feature/3632' into develop

096bbb3

Close #3632

weierophinney closed this Mar 25, 2013

davidwindell deleted the zf3617 branch March 25, 2013 14:14

akrabat mentioned this pull request May 2, 2013

2.2RC1 BC Break: DateTimeFormatter sets blank data to today's date #4393

Closed

weierophinney added a commit that referenced this pull request May 23, 2013

Merge pull request #4499 from localheinz/hotfix/filter-plugin-manager…

f624728

…-unaware-of-datetime-formatter Add service definition for DateTimeFormatter (related to #3632)

grizzm0 mentioned this pull request Jul 26, 2013

Zend\Form\Element\DateTime broken due to filter #4889

Closed

weierophinney added a commit to zendframework/zend-filter that referenced this pull request May 15, 2015

Merge pull request zendframework/zendframework#3632 from davidwindell…

0f73b43

…/zf3617 New DateTimeFormatter Filter (zendframework/zendframework#3617)

weierophinney added a commit to zendframework/zend-filter that referenced this pull request May 15, 2015

[zendframework/zendframework#3632] throw previous exception

ecf40ea

- Incorporate feedback from @marc-mabe - Also: use $e as exception (for consistency)

weierophinney added a commit to zendframework/zend-filter that referenced this pull request May 15, 2015

Merge branch 'feature/3632' into develop

0e07b58

Close zendframework/zendframework#3632

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New DateTimeFormatter Filter (#3617) #3632

New DateTimeFormatter Filter (#3617) #3632

davidwindell commented Jan 31, 2013

samsonasik Jan 31, 2013

marc-mabe commented Jan 31, 2013

Maks3w commented Jan 31, 2013

Maks3w Jan 31, 2013

davidwindell commented Feb 1, 2013

Maks3w Feb 1, 2013

Maks3w commented Feb 1, 2013

Freeaqingme Mar 6, 2013

weierophinney Mar 11, 2013

davidwindell Mar 11, 2013

weierophinney Mar 11, 2013

weierophinney commented Mar 11, 2013

davidwindell commented Mar 13, 2013

marc-mabe Mar 13, 2013

davidwindell Mar 13, 2013

marc-mabe Mar 13, 2013

davidwindell Mar 20, 2013

marc-mabe Mar 21, 2013

weierophinney commented Mar 25, 2013

New DateTimeFormatter Filter (#3617) #3632

New DateTimeFormatter Filter (#3617) #3632

Conversation

davidwindell commented Jan 31, 2013

Choose a reason for hiding this comment

marc-mabe commented Jan 31, 2013

Maks3w commented Jan 31, 2013

Choose a reason for hiding this comment

davidwindell commented Feb 1, 2013

Choose a reason for hiding this comment

Maks3w commented Feb 1, 2013

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

weierophinney commented Mar 11, 2013

davidwindell commented Mar 13, 2013

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

weierophinney commented Mar 25, 2013