added missing phpdoc
authorFabien Potencier <fabien.potencier@gmail.com>
Fri, 6 Jan 2012 19:35:29 +0000 (20:35 +0100)
committerFabien Potencier <fabien.potencier@gmail.com>
Fri, 6 Jan 2012 19:35:29 +0000 (20:35 +0100)
lib/Twig/Extension/Core.php

index 1e18be3..f78be90 100644 (file)
@@ -329,6 +329,20 @@ function twig_date_format_filter(Twig_Environment $env, $date, $format = null, $
     return twig_date_converter($date, $timezone)->format($format);
 }
 
+/**
+ * Converts an input to a DateTime instance.
+ *
+ * <pre>
+ *    {% if date(user.created_at) < date('+2days') %}
+ *      {# do something #}
+ *    {% endif %}
+ * </pre>
+ *
+ * @param DateTime|string     $date     A date
+ * @param DateTimeZone|string $timezone A timezone
+ *
+ * @return DateTime A DateTime instance
+ */
 function twig_date_converter($date = null, $timezone = null)
 {
     if ($date instanceof DateTime) {