Kunstmaan / KunstmaanBundlesCMS

src/Kunstmaan/AdminBundle/Twig/DateByLocaleExtension.php

<?php

namespace Kunstmaan\AdminBundle\Twig;

use IntlDateFormatter as DateFormatter;
use Twig\Extension\AbstractExtension;
use Twig\TwigFilter;

/**
 * DateByLocaleExtension
 *
 * @final since 5.4
 */
class DateByLocaleExtension extends AbstractExtension
{
    /**
     * Get Twig filters defined in this extension.
     *
     * @return array

Consider making the return type a bit more specific; maybe use TwigFilter[].

     */
    public function getFilters()
    {
        return array(
            new TwigFilter('localeDate', '\Kunstmaan\AdminBundle\Twig\DateByLocaleExtension::localeDateFilter'),
        );
    }

    /**
     * A date formatting filter for Twig, renders the date using the specified parameters.
     *
     * @param mixed  $date     Unix timestamp to format
     * @param string $locale   The locale
     * @param string $dateType The date type
     * @param string $timeType The time type
     * @param string $pattern  The pattern to use

Should the type for parameter $pattern not be string|null?

     *
     * @return string
     */
    public static function localeDateFilter($date, $locale = 'nl', $dateType = 'medium', $timeType = 'none', $pattern = null)
    {
        $values = array(
            'none' => DateFormatter::NONE,
            'short' => DateFormatter::SHORT,
            'medium' => DateFormatter::MEDIUM,
            'long' => DateFormatter::LONG,
            'full' => DateFormatter::FULL,
        );

        if (\is_null($pattern)) {
            $dateFormatter = DateFormatter::create(
                $locale,
                $values[$dateType],
                $values[$timeType], 'Europe/Brussels'
            );
        } else {
            $dateFormatter = DateFormatter::create(
                $locale,
                $values[$dateType],
                $values[$timeType], 'Europe/Brussels',
                DateFormatter::GREGORIAN,
                $pattern
            );
        }

        return $dateFormatter->format($date);
    }
}