Chadicus\Util\DateTimeZone

Complexity

Total Complexity

9

Size/Duplication

Total Lines	81
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	5
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	fromString()	0	12	3
A	fromOffset()	0	12	3
A	getLongName()	0	11	3

<?php
namespace SubjectivePHP\Util;

/**
 * Static utility class for working with DateTimeZone objects.
 */
abstract class DateTimeZone
{
    /**
     * Array of edge case timezones
     *
     * @var array
     */
    private static $outliers = [
        'WIB' => 'Asia/Jakarta',  //Western Indonesian Time
        'FET' => 'Europe/Helsinki', //Further-eastern European Time
        'AEST' => 'Australia/Tasmania', //Australia Eastern Standard Time
        'AWST' => 'Australia/West', //Australia Western Standard Time
        'WITA' => 'Asia/Makassar',
        'AEDT' => 'Australia/Sydney', //Australia Eastern Daylight Time
        'ACDT' => 'Australia/Adelaide', //Australia Central Daylight Time
    ];

    /**
     * Returns a \DateTimeZone instance for the give nameOrAbbreviation.
     *
     * @param string        $nameOrAbbreviation The timezone nameOrAbbreviation.
     * @param \DateTimeZone $default            The default timezone to return if none can be created.
     *
     * @return \DateTimeZone
     */
    final public static function fromString($nameOrAbbreviation, \DateTimeZone $default = null)
    {
        try {
            return new \DateTimeZone($nameOrAbbreviation);
        } catch (\Exception $e) {
            if (array_key_exists($nameOrAbbreviation, self::$outliers)) {
                return new \DateTimeZone(self::$outliers[$nameOrAbbreviation]);
            }

            return $default;
        }
    }

    /**
     * Returns a \DateTimeZone object based on gmt offset.
     *
     * @param integer $gmtOffset         Offset from GMT in seconds.
     * @param boolean $isDaylightSavings Daylight saving time indicator.
     *
     * @return \DateTimeZone
     *
     * @throws \InvalidArgumentException Thrown if $gmtOffset is not an integer.
     * @throws \InvalidArgumentException Thrown if $isDaylightSavings is not a boolean.
     */
    final public static function fromOffset($gmtOffset, $isDaylightSavings)
    {
        if (!is_int($gmtOffset)) {
            throw new \InvalidArgumentException('$gmtOffset must be an integer');
        }

        if (!is_bool($isDaylightSavings)) {
            throw new \InvalidArgumentException('$isDaylightSavings must be a boolean');
        }

        return self::fromString(timezone_name_from_abbr('', $gmtOffset, (int)$isDaylightSavings));
    }

    /**
     * Returns the long name of the given \DateTimeZone.
     *
     * @param \DateTimeZone $timezone The timezone object from which the long name should be obtained.
     *
     * @return string
     */
    final public static function getLongName(\DateTimeZone $timezone)
    {
        $nameFromTimeZone = $timezone->getName();
        if (strlen($nameFromTimeZone) > 6) {
            return $nameFromTimeZone;
        }

        $nameFromAbbr = timezone_name_from_abbr($nameFromTimeZone);

        return $nameFromAbbr === false ? $nameFromTimeZone : $nameFromAbbr;
    }
}