vendor/sonata-project/intl-bundle/src/Twig/Extension/DateTimeExtension.php line 126

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of the Sonata Project package.
  7.  *
  8.  * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
  9.  *
  10.  * For the full copyright and license information, please view the LICENSE
  11.  * file that was distributed with this source code.
  12.  */
  14. namespace Sonata\IntlBundle\Twig\Extension;
  16. use Sonata\IntlBundle\Helper\DateTimeFormatterInterface;
  17. use Sonata\IntlBundle\Templating\Helper\DateTimeHelper as TemplatingDateTimeHelper;
  18. use Sonata\IntlBundle\Twig\DateTimeRuntime;
  19. use Twig\Extension\AbstractExtension;
  20. use Twig\TwigFilter;
  22. /**
  23.  * DateTimeExtension extends Twig with localized date/time capabilities.
  24.  *
  25.  * @author Thomas Rabaix <thomas.rabaix@ekino.com>
  26.  */
  27. class DateTimeExtension extends AbstractExtension
  28. {
  29.     /**
  30.      * @var DateTimeFormatterInterface|TemplatingDateTimeHelper
  31.      */
  32.     protected $helper;
  34.     private DateTimeRuntime $dateTimeRuntime;
  36.     /**
  37.      * NEXT_MAJOR: Remove this constructor.
  38.      *
  39.      * @param DateTimeFormatterInterface|TemplatingDateTimeHelper $helper
  40.      */
  41.     public function __construct(object $helper)
  42.     {
  43.         if ($helper instanceof TemplatingDateTimeHelper) {
  44.             @trigger_error(
  45.                 sprintf('The use of %s is deprecated since 2.13, use %s instead.', TemplatingDateTimeHelper::class, DateTimeFormatterInterface::class),
  46.                 \E_USER_DEPRECATED
  47.             );
  48.         } elseif (!$helper instanceof DateTimeFormatterInterface) {
  49.             throw new \TypeError(sprintf('Helper must be an instanceof %s, instanceof %s given', DateTimeFormatterInterface::class, \get_class($helper)));
  50.         }
  51.         $this->helper = $helper;
  52.         $this->dateTimeRuntime = new DateTimeRuntime($helper);
  53.     }
  55.     /**
  56.      * @return TwigFilter[]
  57.      */
  58.     public function getFilters()
  59.     {
  60.         return [
  61.             new TwigFilter('format_date', [$this, 'formatDate'], ['is_safe' => ['html']]), // NEXT_MAJOR: Remove this line
  62.             new TwigFilter('sonata_format_date', [DateTimeRuntime::class, 'formatDate'], ['is_safe' => ['html']]),
  63.             new TwigFilter('format_time', [$this, 'formatTime'], ['is_safe' => ['html']]), // NEXT_MAJOR: Remove this line
  64.             new TwigFilter('sonata_format_time', [DateTimeRuntime::class, 'formatTime'], ['is_safe' => ['html']]),
  65.             new TwigFilter('format_datetime', [$this, 'formatDatetime'], ['is_safe' => ['html']]), // NEXT_MAJOR: Remove this line
  66.             new TwigFilter('sonata_format_datetime', [DateTimeRuntime::class, 'formatDatetime'], ['is_safe' => ['html']]),
  67.         ];
  68.     }
  70.     /**
  71.      * NEXT_MAJOR: Remove this method.
  72.      *
  73.      * @param \DateTime|string|int $date
  74.      * @param string|null          $pattern
  75.      * @param string|null          $locale
  76.      * @param string|null          $timezone
  77.      * @param int|null             $dateType
  78.      *
  79.      * @return string
  80.      */
  81.     public function formatDate($date, $pattern = null, $locale = null, $timezone = null, $dateType = null)
  82.     {
  83.         @trigger_error(
  84.             'The format_date filter is deprecated since 2.12 and will be removed on 3.0. '.
  85.             'Use sonata_format_date instead.',
  86.             \E_USER_DEPRECATED
  87.         );
  89.         return $this->dateTimeRuntime->formatDate($date, $pattern, $locale, $timezone, $dateType);
  90.     }
  92.     /**
  93.      * NEXT_MAJOR: Remove this method.
  94.      *
  95.      * @param \DateTime|string|int $time
  96.      * @param string|null          $pattern
  97.      * @param string|null          $locale
  98.      * @param string|null          $timezone
  99.      * @param int|null             $timeType
  100.      *
  101.      * @return string
  102.      */
  103.     public function formatTime($time, $pattern = null, $locale = null, $timezone = null, $timeType = null)
  104.     {
  105.         @trigger_error(
  106.             'The format_time filter is deprecated since 2.12 and will be removed on 3.0. '.
  107.             'Use sonata_format_time instead.',
  108.             \E_USER_DEPRECATED
  109.         );
  111.         return $this->dateTimeRuntime->formatTime($time, $pattern, $locale, $timezone, $timeType);
  112.     }
  114.     /**
  115.      * NEXT_MAJOR: Remove this method.
  116.      *
  117.      * @param \DateTime|string|int $time
  118.      * @param string|null          $pattern
  119.      * @param string|null          $locale
  120.      * @param string|null          $timezone
  121.      * @param int|null             $dateType
  122.      * @param int|null             $timeType
  123.      *
  124.      * @return string
  125.      */
  126.     public function formatDatetime($time, $pattern = null, $locale = null, $timezone = null, $dateType = null, $timeType = null)
  127.     {
  128.         @trigger_error(
  129.             'The format_date_time filter is deprecated since 2.12 and will be removed on 3.0. '.
  130.             'Use sonata_format_date_time instead.',
  131.             \E_USER_DEPRECATED
  132.         );
  134.         return $this->dateTimeRuntime->formatDatetime($time, $pattern, $locale, $timezone, $timeType);
  135.     }
  137.     /**
  138.      * NEXT_MAJOR: remove this method.
  139.      *
  140.      * @deprecated since sonata-project/intl-bundle 2.8, to be removed in version 3.0.
  141.      *
  142.      * @return string
  143.      */
  144.     public function getName()
  145.     {
  146.         return 'sonata_intl_datetime';
  147.     }
  148. }