twig扩展

twig模板引擎默认提供了一些函数和标签，但是有时内置的函数满足不了要求时就需要对twig进行扩展了。

现在我们想让博客的评论时间显示为多久之前发布的，如：发布于3小时前。

之前在模板中渲染发布时间的用法是：{{ comment.created|date('l, F j, Y') }}，而现在想变为：{{ comment.created|created_ago }}这种形式。

由于twig没有提供created_ago方法，因此这得我们自己实现。

新建文件src/Blogger/BlogBundle/Twig/Extensions/BloggerBlogExtension.php：

  1. <?php
  3. namespace Blogger\BlogBundle\Twig\Extensions;
  5. /**
  6.  * BloggerBlogExtension
  7.  */
  8. class BloggerBlogExtension extends \Twig_Extension
  9. {
  10.     /**
  11.      * @return array
  12.      */
  13.     public function getFilters()
  14.     {
  15.         return array(
  16.             'created_ago' => new \Twig_Filter_Method($this, 'createdAgo'),
  17.         );
  18.     }
  20.     /**
  21.      * @param \DateTime $dateTime
  22.      *
  23.      * @return string
  24.      */
  25.     public function createdAgo(\DateTime $dateTime)
  26.     {
  27.         $delta = time() - $dateTime->getTimestamp();
  28.         if ($delta < 0) {
  29.             throw new \InvalidArgumentException("createdAgo is unable to handle dates in the future");
  30.         }
  32.         $duration = "";
  33.         if ($delta < 60) {
  34.             // Seconds
  35.             $time = $delta;
  36.             $duration = $time . " second" . (($time > 1) ? "s" : "") . " ago";
  37.         } else if ($delta <= 3600) {
  38.             // Mins
  39.             $time = floor($delta / 60);
  40.             $duration = $time . " minute" . (($time > 1) ? "s" : "") . " ago";
  41.         } else if ($delta <= 86400) {
  42.             // Hours
  43.             $time = floor($delta / 3600);
  44.             $duration = $time . " hour" . (($time > 1) ? "s" : "") . " ago";
  45.         } else {
  46.             // Days
  47.             $time = floor($delta / 86400);
  48.             $duration = $time . " day" . (($time > 1) ? "s" : "") . " ago";
  49.         }
  51.         return $duration;
  52.     }
  54.     /**
  55.      * @return string
  56.      */
  57.     public function getName()
  58.     {
  59.         return 'blogger_blog_extension';
  60.     }
  61. }

这里我们定义一个类继承自Twig_Extension。要创建自定义过滤器，只需要覆盖getFilters()方法即可。如果要创建自定义方法，则覆盖getFunctions()方法。

定义了扩展类之后再将其注册为一个服务，编辑文件src/Blogger/BlogBundle/Resources/config/services.yml：

  1. services:
  2.     blogger_blog.twig.extension:
  3.         class: Blogger\BlogBundle\Twig\Extensions\BloggerBlogExtension
  4.         tags:
  5.             - { name: twig.extension }

现在就可以在模板中使用我们刚刚定义的created_ago过滤器了。更新模板，将{{ comment.created|date('l, F j, Y') }}替换成{{ comment.created|created_ago }}。