TranslationManager::initialize() - Code Metrics - horros/agavi2 - Measure and Improve Code Quality continuously with Scrutinizer

TranslationManager::initialize() B
last analyzed 2017-05-30 13:20 UTC

↳ Parent: TranslationManager
Complexity

Conditions	4
Paths	5
Size

Total Lines	22
Code Lines	13
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	4
eloc	13
nc	5
nop	2
dl	0
loc	22
rs	8.9197
c	0
b	0
f	0
<?php

// +---------------------------------------------------------------------------+
// | This file is part of the Agavi package.                                   |
// | Copyright (c) 2005-2011 the Agavi Project.                                |
// |                                                                           |
// | For the full copyright and license information, please view the LICENSE   |
// | file that was distributed with this source code. You can also view the    |
// | LICENSE file online at http://www.agavi.org/LICENSE.txt                   |
// |   vi: set noexpandtab:                                                    |
// |   Local Variables:                                                        |
// |   indent-tabs-mode: t                                                     |
// |   End:                                                                    |
// +---------------------------------------------------------------------------+

namespace Agavi\Translation;

use Agavi\Config\Config;
use Agavi\Config\ConfigCache;
use Agavi\Core\Context;
use Agavi\Date\Calendar;
use Agavi\Date\DateDefinitions;
use Agavi\Date\DateFormat;
use Agavi\Date\GregorianCalendar;
use Agavi\Date\OlsonTimeZone;
use Agavi\Date\TimeZone;
use Agavi\Exception\AgaviException;
use Agavi\Exception\Exception;

/**
 * The translation manager manages the interface between the application and the
 * current translation engine implementation
 *
 * @package    agavi
 * @subpackage translation
 *
 * @author     Dominik del Bondio <[email protected]>
 * @copyright  Authors
 * @copyright  The Agavi Project
 *
 * @since      0.11.0
 *
 * @version    $Id$
 */
class TranslationManager
{
    const MESSAGE = 'msg';
    const NUMBER = 'num';
    const CURRENCY = 'cur';
    const DATETIME = 'date';

    /**
     * @var        Context A Context instance.
     */
    protected $context = null;

    /**
     * @var        array An array of the translator instances for the domains.
     */
    protected $translators = array();

    /**
     * @var        Locale The current locale.
     */
    protected $currentLocale = null;

    /**
     * @var        string The original locale identifier given to this instance.
     */
    protected $givenLocaleIdentifier = null;

    /**
     * @var        string The identifier of the current locale.
     */
    protected $currentLocaleIdentifier = null;

    /**
     * @var        string The default locale identifier.
     */
    protected $defaultLocaleIdentifier = null;

    /**
     * @var        string The default domain which shall be used for translation.
     */
    protected $defaultDomain = null;

    /**
     * @var        array The available locales which have been defined in the
     *                   translation.xml config file.
     */
    protected $availableConfigLocales = array();

    /**
     * @var        array All available locales. Just stores the info for lazyload.
     */
    protected $availableLocales = array();

    /**
     * @var        array A cache for locale instances.
     */
    protected $localeCache = array();

    /**
     * @var        array A cache for locale identifiers resolved from a string.
     */
    protected $localeIdentifierCache = array();

    /**
     * @var        array A cache for the data of the available locales.
     */
    protected $localeDataCache = array();

    /**
     * @var        array The supplemental data from the cldr
     */
    protected $supplementalData = array();

    /**
     * @var        array The list of available time zones.
     */
    protected $timeZoneList = array();

    /**
     * @var        array A cache for the time zone instances.
     */
    protected $timeZoneCache = array();

    /**
     * @var        string The default time zone. If not set the timezone php
     *                    will be used as default.
     */
    protected $defaultTimeZone = null;

    /**
     * Initialize this TranslationManager.
     *
     * @param      Context $context    The current application context.
     * @param      array   $parameters An associative array of initialization parameters.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    public function initialize(Context $context, array $parameters = array())
    {
        $this->context = $context;

        include(ConfigCache::checkConfig(Config::get('core.config_dir') . '/translation.xml'));
        $this->loadSupplementalData();
        $this->loadTimeZoneData();
        $this->loadAvailableLocales();
        if ($this->defaultLocaleIdentifier === null) {
            throw new AgaviException('Tried to use the translation system without a default locale and without a locale set');
        }
        $this->setLocale($this->defaultLocaleIdentifier);

        if ($this->defaultTimeZone === null) {
            $this->defaultTimeZone = date_default_timezone_get();
        }
        
        if ($this->defaultTimeZone === 'System/Localtime') {
            // http://trac.agavi.org/ticket/1008
            throw new AgaviException("Your default timezone is 'System/Localtime', which likely means that you're running Debian, Ubuntu or some other Linux distribution that chose to include a useless and broken patch for system timezone database lookups into their PHP package, despite this very change being declined by the PHP development team for inclusion into PHP itself.\nThis pseudo-timezone, which is not defined in the standard 'tz' database used across many operating systems and applications, works for internal PHP classes and functions because the 'real' system timezone is resolved instead, but there is no way for an application to obtain the actual timezone name that 'System/Localtime' resolves to internally - information Agavi needs to perform accurate calculations and operations on dates and times.\n\nPlease set a correct timezone name (e.g. Europe/London) via 'date.timezone' in php.ini, use date_default_timezone_set() to set it in your code, or define a default timezone for Agavi to use in translation.xml. If you have some minutes to spare, file a bug report with your operating system vendor about this problem.\n\nIf you'd like to learn more about this issue, please refer to http://trac.agavi.org/ticket/1008");
        }
    }

    /**
     * Do any necessary startup work after initialization.
     *
     * This method is not called directly after initialize().
     *
     * @author     David Zülke <[email protected]>
     * @since      0.11.0
     */
    public function startup()
    {
    }

    /**
     * Execute the shutdown procedure.
     *
     * @author     David Zülke <[email protected]>
     * @since      0.11.0
     */
    public function shutdown()
    {
    }

    /**
     * Retrieve the current application context.
     *
     * @return     Context The current Context instance.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    final public function getContext()
    {
        return $this->context;
    }

    /**
     * Returns the list of available locales.
     *
     * @author     David Zülke <[email protected]>
     * @since      0.11.0
     */
    public function getAvailableLocales()
    {
        return $this->availableLocales;
    }

    /**
     * Sets the current locale.
     *
     * @param      string $identifier The locale identifier.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    public function setLocale($identifier)
    {
        $this->currentLocaleIdentifier = $this->getLocaleIdentifier($identifier);
        $givenData = Locale::parseLocaleIdentifier($identifier);
        $actualData = Locale::parseLocaleIdentifier($this->currentLocaleIdentifier);
        // construct the given name from the locale from the closest match and the options that were given to the requested locale identifier
        $this->givenLocaleIdentifier = $actualData['locale_str'] . $givenData['option_str'];
    }

    /**
     * Retrieve the current locale.
     *
     * @return     Locale The current locale.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    public function getCurrentLocale()
    {
        $this->loadCurrentLocale();
        return $this->currentLocale;
    }

    /**
     * Retrieve the current locale identifier. This may not necessarily match
     * what has be given to setLocale() but instead the identifier of the closest
     * match from the available locales.
     *
     * @return     string The locale identifier.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    public function getCurrentLocaleIdentifier()
    {
        return $this->currentLocaleIdentifier;
    }

    /**
     * Retrieve the default locale.
     *
     * @return     Locale The current default.
     *
     * @author     David Zülke <[email protected]>
     * @since      0.11.0
     */
    public function getDefaultLocale()
    {
        return $this->getLocale($this->getDefaultLocaleIdentifier());
    }

    /**
     * Retrieve the default locale identifier.
     *
     * @return     string The default locale identifier.
     *
     * @author     David Zülke <[email protected]>
     * @since      0.11.0
     */
    public function getDefaultLocaleIdentifier()
    {
        return $this->defaultLocaleIdentifier;
    }

    /**
     * Sets the default domain.
     *
     * @param      string $domain The new default domain.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    public function setDefaultDomain($domain)
    {
        $this->defaultDomain = $domain;
    }

    /**
     * Retrieve the default domain.
     *
     * @return     string The default domain.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    public function getDefaultDomain()
    {
        return $this->defaultDomain;
    }

    /**
     * Formats a date in the current locale.
     *
     * @param      mixed  $date   The date to be formatted.
     * @param      string $domain The domain in which the date should be formatted.
     * @param      Locale $locale The locale which should be used for formatting.
     *                            Defaults to the currently active locale.
     *
     * @return     string The formatted date.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    public function _d($date, $domain = null, $locale = null)

    {
        if ($domain === null) {
            $domain = $this->defaultDomain;
        }

        if ($locale === null) {
            $this->loadCurrentLocale();
        } elseif (is_string($locale)) {
            $locale = $this->getLocale($locale);
        }
        
        $domainExtra = '';
        $translator = $this->getTranslators($domain, $domainExtra, self::DATETIME);

        $retval = $translator->translate($date, $domainExtra, $locale);
        
        $retval = $this->applyFilters($retval, $domain, self::DATETIME);
        
        return $retval;
    }

    /**
     * Formats a currency amount in the current locale.
     *
     * @param      mixed  $number The number to be formatted.
     * @param      string $domain The domain in which the amount should be formatted.
     * @param      Locale $locale The locale which should be used for formatting.
     *                            Defaults to the currently active locale.
     *
     * @return     string The formatted number.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    public function _c($number, $domain = null, $locale = null)

    {
        if ($domain === null) {
            $domain = $this->defaultDomain;
        }

        if ($locale === null) {
            $this->loadCurrentLocale();
        } elseif (is_string($locale)) {
            $locale = $this->getLocale($locale);
        }
        
        $domainExtra = '';
        $translator = $this->getTranslators($domain, $domainExtra, self::CURRENCY);

        $retval = $translator->translate($number, $domainExtra, $locale);
        
        $retval = $this->applyFilters($retval, $domain, self::CURRENCY);
        
        return $retval;
    }

    /**
     * Formats a number in the current locale.
     *
     * @param      mixed  $number The number to be formatted.
     * @param      string $domain The domain in which the number should be formatted.
     * @param      Locale $locale The locale which should be used for formatting.
     *                            Defaults to the currently active locale.
     *
     * @return     string The formatted number.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    public function _n($number, $domain = null, $locale = null)

    {
        if ($domain === null) {
            $domain = $this->defaultDomain;
        }

        if ($locale === null) {
            $this->loadCurrentLocale();
        } elseif (is_string($locale)) {
            $locale = $this->getLocale($locale);
        }
        
        $domainExtra = '';
        $translator = $this->getTranslators($domain, $domainExtra, self::NUMBER);

        $retval = $translator->translate($number, $domainExtra, $locale);
        
        $retval = $this->applyFilters($retval, $domain, self::NUMBER);
        
        return $retval;
    }

    /**
     * Translate a message into the current locale.
     *
     * @param      mixed  $message    The message.
     * @param      string $domain     The domain in which the translation should be done.
     * @param      Locale $locale     The locale which should be used for formatting.
     *                                Defaults to the currently active locale.
     * @param      array  $parameters The parameters which should be used for sprintf on
     *                                the translated string.
     *
     * @return     string The translated message.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    public function _($message, $domain = null, $locale = null, array $parameters = null)
    {
        if ($domain === null) {
            $domain = $this->defaultDomain;
        }
        
        if ($locale === null) {
            $this->loadCurrentLocale();
        } elseif (is_string($locale)) {
            $locale = $this->getLocale($locale);
        }
        
        $domainExtra = '';
        $translator = $this->getTranslators($domain, $domainExtra, self::MESSAGE);

        $retval = $translator->translate($message, $domainExtra, $locale);
        if (is_array($parameters)) {
            $retval = vsprintf($retval, $parameters);
        }
        
        $retval = $this->applyFilters($retval, $domain, self::MESSAGE);
        
        return $retval;
    }

    /**
     * Translate a singular/plural message into the current locale.
     *
     * @param      string $singularMessage The message for the singular form.
     * @param      string $pluralMessage   The message for the plural form.
     * @param      int    $amount          The amount for which the translation should happen.
     * @param      string $domain          The domain in which the translation should be done.
     * @param      Locale $locale          The locale which should be used for formatting.
     *                                     Defaults to the currently active locale.
     * @param      array  $parameters      The parameters which should be used for sprintf on
     *                                     the translated string.
     *
     * @return     string The translated message.
     *
     * @author     David Zülke <[email protected]>
     * @since      0.11.0
     */
    public function __($singularMessage, $pluralMessage, $amount, $domain = null, $locale = null, array $parameters = null)
    {
        return $this->_(array($singularMessage, $pluralMessage, $amount), $domain, $locale, $parameters);
    }

    /**
     * Returns the translators for a given domain.
     *
     * @param      string $domain      The domain.
     * @param      string $domainExtra The remaining part in the domain which didn't match
     * @param      string $type        The type of the translator
     *
     * @return     TranslatorInterface An array of translators for the given domain
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    protected function getTranslators(&$domain, &$domainExtra, $type = null)
    {
        if ($domain[0] == '.') {
            $domain = $this->defaultDomain . $domain;
        }

        $domainParts = explode('.', $domain);

        do {
            if (count($domainParts) == 0) {
                throw new \InvalidArgumentException(sprintf('No translator exists for the domain "%s"', $domain));
            }
            $td = implode('.', $domainParts);
            array_pop($domainParts);
        } while (!isset($this->translators[$td]) || ($type && !isset($this->translators[$td][$type])));
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false

        $domainExtra = substr($domain, strlen($td) + 1);
        $domain = $td;
        return $type ? $this->translators[$td][$type] : $this->translators[$td];
    }

    /**
     * Returns the translators for a given domain and type. The domain can contain
     * any extra parts which will be ignored. Will return null when no translator
     * is defined.
     *
     * @param      string $domain The domain.
     * @param      string $type   The type of the translator.
     *
     * @return     TranslatorInterface The translator instance.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    public function getDomainTranslator($domain, $type)
    {
        try {
            $domainExtra = '';
            return $this->getTranslators($domain, $domainExtra, $type);
        } catch (\InvalidArgumentException $e) {
            return null;
        }
    }

    /**
     * Returns the translator filters for a given domain.
     *
     * @param      string $message The message.
     * @param      string $domain  The domain (w/o extra parts).
     * @param      string $type    The type.
     *
     * @return     string The new message.
     *
     * @author     David Zülke <[email protected]>
     * @since      0.11.0
     */
    protected function applyFilters($message, $domain, $type = self::MESSAGE)
    {
        if (isset($this->translatorFilters[$domain][$type])) {
            foreach ($this->translatorFilters[$domain][$type] as $filter) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
                $message = call_user_func($filter, $message);
            }
        }
        
        return $message;
    }

    /**
     * Loads the available locales into the instance variable
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    protected function loadAvailableLocales()
    {
        $this->availableLocales = $this->availableConfigLocales;
    }

    /**
     * Lazy loads the current locale if necessary.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    protected function loadCurrentLocale()
    {
        if (!$this->currentLocale || $this->currentLocale->getIdentifier() != $this->givenLocaleIdentifier) {
            $this->currentLocale = $this->getLocale($this->givenLocaleIdentifier);
            // we first need to initialize all message translators before the number formatters
            foreach ($this->translators as $translatorList) {

                /**
                 * @var string $type
                 * @var TranslatorInterface $translator
                 */
                foreach ($translatorList as $type => $translator) {
                    if ($type == self::MESSAGE) {
                        $translator->localeChanged($this->currentLocale);
                    }
                }
            }
            foreach ($this->translators as $translatorList) {

                foreach ($translatorList as $type => $translator) {
                    if ($type != self::MESSAGE) {
                        $translator->localeChanged($this->currentLocale);
                    }
                }
            }
        }
    }

    /**
     * Loads the supplemental data into the instance variable
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    protected function loadSupplementalData()
    {
        $this->supplementalData = include(ConfigCache::checkConfig(Config::get('core.cldr_dir') . '/supplementalData.xml'));
    }

    /**
     * Loads the time zone data.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    protected function loadTimeZoneData()
    {
        $this->timeZoneList = include(Config::get('core.cldr_dir') . '/timezones/zonelist.php');
    }

    /**
     * Returns all the identifiers of the available locales which match the given
     * locale identifier.
     *
     * @param      string $identifier A locale identifier
     *
     * @return     array The actual locale identifiers of the available locales.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @author     David Zülke <[email protected]>
     * @author     Thomas Bachem <[email protected]>
     */
    public function getMatchingLocaleIdentifiers($identifier)
    {
        // if a locale with the given identifier doesn't exist try to find the closest matches
        if (isset($this->availableLocales[$identifier])) {
            return array($identifier);
        }
        
        $idData = Locale::parseLocaleIdentifier($identifier);
        
        $matchingLocaleIdentifiers = array();
        // iterate over all available locales
        foreach ($this->availableLocales as $availableLocaleIdentifier => $availableLocale) {
            $matched = false;
            // iterate over possible properties to compare against (all given ones must match)
            foreach (array('language', 'script', 'territory', 'variant') as $propertyName) {
                // only perform check if property was in $identifier
                if (isset($idData[$propertyName])) {
                    // compare against data in locale
                    if ($idData[$propertyName] == $availableLocale['identifierData'][$propertyName]) {
                        // fine, continue with next
                        $matched = true;
                    } else {
                        // failed, so we can bail out early and declare as non-matched
                        $matched = false;
                        break;
                    }
                }
            }
            if ($matched) {
                $matchingLocaleIdentifiers[] = $availableLocaleIdentifier;
            }
        }
        
        return $matchingLocaleIdentifiers;
    }

    /**
     * Returns the identifier of the available locale which matches the given
     * locale identifier most.
     *
     * @param      string $identifier A locale identifier
     *
     * @return     string The actual locale identifier of the available locale.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @author     David Zülke <[email protected]>
     * @since      0.11.0
     */
    public function getLocaleIdentifier($identifier)
    {
        if (isset($this->localeIdentifierCache[$identifier])) {
            return $this->localeIdentifierCache[$identifier];
        }
        
        $matchingLocaleIdentifiers = $this->getMatchingLocaleIdentifiers($identifier);
        
        switch (count($matchingLocaleIdentifiers)) {
            case 1:
                $availableLocaleIdentifier = current($matchingLocaleIdentifiers);
                break;
            case 0:
                throw new AgaviException('Specified locale identifier ' . $identifier . ' which has no matching available locale defined');
            default:
                throw new AgaviException('Specified ambiguous locale identifier ' . $identifier . ' which has matches: ' . implode(', ', $matchingLocaleIdentifiers));
        }
        
        return $this->localeIdentifierCache[$identifier] = $availableLocaleIdentifier;
    }

    /**
     * Returns a new AgaviLocale object from the given identifier.
     *
     * @param      string $identifier The locale identifier
     * @param      bool   $forceNew   Force a new instance even if an identical one exists.
     *
     * @return     Locale The locale instance which matches the available
     *                         locales most.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @author     David Zülke <[email protected]>
     * @since      0.11.0
     */
    public function getLocale($identifier, $forceNew = false)
    {
        // enable shortcut notation to only set options to the current locale
        if ($identifier[0] == '@' && $this->currentLocaleIdentifier) {
            $idData = Locale::parseLocaleIdentifier($this->currentLocaleIdentifier);
            $identifier = $idData['locale_str'] . $identifier;

            $newIdData = Locale::parseLocaleIdentifier($identifier);
            $idData['options'] = array_merge($idData['options'], $newIdData['options']);
        } else {
            $idData = Locale::parseLocaleIdentifier($identifier);
        }
        // this doesn't care about the options
        $availableLocale = $this->availableLocales[$this->getLocaleIdentifier($identifier)];

        // if the user wants all options reset he supplies an 'empty' option set (identifier ends with @)
        if (substr($identifier, -1) == '@') {
            $idData['options'] = array();
        } else {
            $idData['options'] = array_merge($availableLocale['identifierData']['options'], $idData['options']);
        }

        if (($atPos = strpos($identifier, '@')) !== false) {
            $identifier = $availableLocale['identifierData']['locale_str'] . substr($identifier, $atPos);
        } else {
            $identifier = $availableLocale['identifier'];
        }

        if (!$forceNew && isset($this->localeCache[$identifier])) {
            return $this->localeCache[$identifier];
        }

        if (!isset($this->localeDataCache[$idData['locale_str']])) {
            $lookupPath = Locale::getLookupPath($availableLocale['identifierData']);
            $cldrDir = Config::get('core.cldr_dir');
            $data = null;

            foreach ($lookupPath as $localeName) {
                $fileName = $cldrDir . '/locales/' . $localeName . '.xml';
                if (is_readable($fileName)) {
                    $data = include(ConfigCache::checkConfig($fileName));
                    break;
                }
            }
            if ($data === null) {
                throw new AgaviException('No data available for locale ' . $identifier);
            }

            if ($availableLocale['identifierData']['territory']) {
                $territory = $availableLocale['identifierData']['territory'];
                if (isset($this->supplementalData['territories'][$territory]['currencies'])) {
                    $slice = array_slice($this->supplementalData['territories'][$territory]['currencies'], 0, 1);
                    $currency = current($slice);
                    $data['locale']['currency'] = $currency['currency'];
                }
            }

            $this->localeDataCache[$idData['locale_str']] = $data;
        }

        $data = $this->localeDataCache[$idData['locale_str']];

        if (isset($idData['options']['calendar'])) {

            $data['locale']['calendar'] = $idData['options']['calendar'];
        }

        if (isset($idData['options']['currency'])) {

            $data['locale']['currency'] = $idData['options']['currency'];
        }

        if (isset($idData['options']['timezone'])) {

            $data['locale']['timezone'] = $idData['options']['timezone'];
        }

        $locale = new Locale();
        $locale->initialize($this->context, $availableLocale['parameters'], $identifier, $data);

        if (!$forceNew) {
            $this->localeCache[$identifier] = $locale;
        }

        return $locale;
    }

    /**
     * Sets the default time zone.
     *
     * @param      string $id The timezone identifier
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    public function setDefaultTimeZone($id)
    {
        $this->defaultTimeZone = $id;
    }

    /**
     * Gets the instance of the current timezone.
     *
     * @return     TimeZone The current timezone instance.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     *
     * @deprecated Superseded by TranslationManager::getDefaultTimeZone()
     */
    public function getCurrentTimeZone()
    {
        return $this->getDefaultTimeZone();
    }

    /**
     * Get the default timezone instance.
     *
     * @return     TimeZone The default timezone instance.
     *
     * @author     David Zülke <[email protected]>
     * @since      1.0.0
     */
    public function getDefaultTimeZone()
    {
        return $this->createTimeZone($this->defaultTimeZone);
    }

    /**
     * Gets the territory id a (resolved) timezone id belongs to.
     *
     * @param      string $id The resolved timezone id.
     * @param      bool   $hasMultipleZones Will receive whether the territory has multiple
     *                    time zones
     *
     * @return     string The territory identifier or null.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    public function getTimeZoneTerritory($id, &$hasMultipleZones = false)
    {
        if (isset($this->supplementalData['timezones']['territories'][$id])) {
            $territory = $this->supplementalData['timezones']['territories'][$id];
            $hasMultipleZones = isset($this->supplementalData['timezones']['multiZones'][$territory]);
            return $territory;
        }

        return null;
    }
    
    /**
     * Resolved the given timezone identifier to its 'real' timezone id.
     *
     * This provides the same functionality like
     * $tm->createTimeZone(id)->getResolvedId() with the difference, that using
     * this method will not create a new timezone instance and look up the
     * resolved id there, but instead directly returns the resolved id by using
     * a simple lookup.
     *
     * @param      int $id The timezone id to be resolved
     * @return     int The resolved timezone id
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      1.0.0
     */
    public function resolveTimeZoneId($id)
    {
        if (isset($this->timeZoneList[$id])) {
            while ($this->timeZoneList[$id]['type'] == 'link') {

                $id = $this->timeZoneList[$id]['to'];
            }
        }
        
        return $id;
    }
    

    /**
     * Creates a new timezone instance for the given identifier.
     *
     * Please note that this method caches the results for each identifier, so
     * if you plan to modify the timezones returned by this method you need to
     * clone them first. Alternatively you can set the cache parameter to false,
     * but this will mean the data for this timezone will be loaded from the
     * hdd again.
     *
     * @return     TimeZone The timezone instance for the given id.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    public function createTimeZone($id, $cache = true)
    {
        if (!isset($this->timeZoneList[$id])) {
            try {
                return TimeZone::createCustomTimeZone($this, $id);
            } catch (\Exception $e) {
                return null;
            }
        }

        if (!isset($this->timeZoneCache[$id]) || !$cache) {
            $currId = $id;

            // resolve links
            while ($this->timeZoneList[$currId]['type'] == 'link') {

                $currId = $this->timeZoneList[$currId]['to'];
            }

            $zoneData = include(Config::get('core.cldr_dir') . '/timezones/' . $this->timeZoneList[$currId]['filename']);

            $zone = new OlsonTimeZone($this, $id, $zoneData);
            $zone->setResolvedId($currId);
            if ($cache) {
                $this->timeZoneCache[$id] = $zone;
            }
        } else {
            $zone = $this->timeZoneCache[$id];
        }

        return $zone;
    }

    /**
     * Creates a new calendar instance with the current time set.
     *
     * @param      mixed $type This can be either a Locale, a TimeZone or
     *                   a string specifying the calendar type.
     *
     * @return     Calendar The current timezone instance.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    public function createCalendar($type = null)
    {
        $locale = $this->getCurrentLocale();
        $calendarType = null;
        $zone = null;
        $time = null;
        if ($type instanceof Locale) {
            $locale = $type;
        } elseif ($type instanceof TimeZone) {
            $zone = $type;
        } elseif ($type instanceof \DateTime) {
            $time = $type;
        } elseif (is_int($type)) {
            $time = $type * DateDefinitions::MILLIS_PER_SECOND;
        } elseif ($type !== null) {
            $calendarType = $type;
        }
        if ($time === null) {
            $time = Calendar::getNow();
        }

        if (!$zone) {
            if ($locale->getLocaleTimeZone()) {
                $zone = $this->createTimeZone($locale->getLocaleTimeZone());
            }
        }

        if (!$calendarType) {
            $calendarType = $locale->getLocaleCalendar();
            if (!$calendarType) {
                $calendarType = Calendar::GREGORIAN;
            }
        }

        switch ($calendarType) {
            case Calendar::GREGORIAN:
                $c = new GregorianCalendar($this /* $locale */);
                break;
            default:
                throw new AgaviException('Calendar type ' . $calendarType . ' not supported');
        }

        // Now, reset calendar to default state:
        if ($zone) {
            $c->setTimeZone($zone);
        }

        if ($time instanceof \DateTime) {
            // FIXME: we can't use $time->getTimezone()->getName() here since that triggers
            // https://github.com/facebook/hhvm/issues/1777 but luckily using format('e')
            // works for both php and hhvm
            $tzName = $time->format('e');

            if (preg_match('/^[+-0-9]/', $tzName)) {
                $tzName = 'GMT' . $tzName;
            }
            $c->setTimeZone($this->createTimeZone($tzName));
            $dateStr = $time->format('Y z G i s');
            list($year, $doy, $hour, $minute, $second) = explode(' ', $dateStr);
            $c->set(DateDefinitions::YEAR, $year);
            $c->set(DateDefinitions::DAY_OF_YEAR, $doy + 1);
            $c->set(DateDefinitions::HOUR_OF_DAY, $hour);
            $c->set(DateDefinitions::MINUTE, $minute);
            $c->set(DateDefinitions::SECOND, $second);

            // complete the calendar
            $c->getAll();
        } else {
            $c->setTime($time); // let the new calendar have the current time.
        }

        return $c;
    }
    
    /**
     * Creates a new date format instance with the given format.
     *
     * @param      string $format The date format.
     *
     * @return     DateFormat The dateformat instance.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    public function createDateFormat($format)
    {
        $dateFormat = new DateFormat($format);
        $dateFormat->initialize($this->getContext());
        return $dateFormat;
    }
    

    /**
     * Returns the stored information from the ldml supplemental data about a
     * territory.
     *
     * @param      string $country The uppercase 2 letter country iso code.
     *
     * @return     array The data.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    public function getTerritoryData($country)
    {
        if (!isset($this->supplementalData['territories'][$country])) {
            return array();
        }
        return $this->supplementalData['territories'][$country];
    }

    /**
     * Returns an array containing digits and rounding information for a currency.
     *
     * @param      string $currency The uppercase 3 letter currency iso code.
     *
     * @return     array The data.
     *
     * @author     Dominik del Bondio <[email protected]>
     * @since      0.11.0
     */
    public function getCurrencyFraction($currency)
    {
        if (!isset($this->supplementalData['fractions'][$currency])) {
            return $this->supplementalData['fractions']['DEFAULT'];
        }
        return $this->supplementalData['fractions'][$currency];
    }
}

horros / agavi2

TranslationManager::initialize() B last analyzed 2017-05-30 13:20 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

TranslationManager::initialize() B
last analyzed 2017-05-30 13:20 UTC
