ICanBoogie/DateTime 2.0.x
  • Namespace
  • Class

Namespaces

  • ICanBoogie
    • DateTime

Classes

  • DateTimeLocalizer
  • ImmutableDateTime
  • MutableDateTime
  • TimeZone
  • TimeZoneLocation

Interfaces

  • DateTime
 1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 
<?php

/*
 * This file is part of the ICanBoogie package.
 *
 * (c) Olivier Laviale <olivier.laviale@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ICanBoogie;

/**
 * Localizes DateTime instances.
 */
class DateTimeLocalizer
{
    const DEFAULT_LOCALE = 'en';

    /**
     * DateTime localizer.
     *
     * @var callable
     */
    static private $localizer;

    /**
     * Defines the localizer.
     *
     * @param callable $localizer
     *
     * @return callable The previous localizer, or `null` if none was defined.
     */
    static public function define(callable $localizer)
    {
        $previous = self::$localizer;

        self::$localizer = $localizer;

        return $previous;
    }

    /**
     * Returns the current localizer.
     *
     * @return callable|null
     */
    static public function defined()
    {
        return self::$localizer;
    }

    /**
     * Undefine the localizer.
     */
    static public function undefine()
    {
        self::$localizer = null;
    }

    /**
     * Localize a {@link DateTime} instance.
     *
     * @param DateTime $datetime
     * @param string $locale
     *
     * @return callable
     */
    static public function localize(DateTime $datetime, $locale = self::DEFAULT_LOCALE)
    {
        $provider = self::$localizer;

        if (!$provider)
        {
            throw new \LogicException("No localizer is defined yet. Please define one with `DateTimeLocalizer::define(\$localizer)`.");
        }

        return $provider($datetime, $locale);
    }
}
ICanBoogie/DateTime 2.0.x API documentation generated by ApiGen