unreal4u\localization

Complexity

Total Complexity

41

Size/Duplication

Total Lines	366
Duplicated Lines	8.74 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	2
Bugs	0	Features	0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	__toString()	0	4	1
A	setDefault()	0	13	2
A	getDefault()	0	5	1
A	_setOptions()	0	6	1
A	sendHeaders()	0	15	4
A	autodetectLocale()	0	8	2
A	formatNumber()	0	17	4
A	getCurrencyISOCode()	0	5	1
A	_getDateObject()	0	14	3
A	formatSimpleDate()	9	9	2
A	formatSimpleTime()	9	9	2
A	_setTimezoneCandidates()	0	10	4
A	getTimeZoneCandidates()	0	4	1
A	setTimezone()	0	13	2
A	isValidTimeZone()	0	14	3
C	getTimezoneOffset()	14	30	7

<?php
/**
 * Main class that defines the Localization class
 *
 * @author unreal4u
 * @link https://github.com/unreal4u/localization
 * @package localization
 * @category mainClass
 */

namespace unreal4u;

/**
 * Class that deals with localization settings
 *
 * This class will handle everything related to locales for you: from number formatting 'till timezones. One particular
 * caveat of this class however is that it doesn't know how to handle with countries that have more than 1 timezone. In
 * this case, it will setup a list with candidates for you to choose from
 *
 * @author "unreal4u / Camilo Sperberg" <me@unreal4u.com>
 * @copyright 2010 - 2014 Camilo Sperberg
 * @version 0.4.1
 * @license BSD License
 */
class localization
{

    /**
     * The version of this class
     * @var string
     */
    private $classVersion = '0.4.1';

    /**
     * Saves the current timezone settings
     * @var \DateTimeZone
     */
    public $timezone = null;

    /**
     * The timezoneId we are in
     * @var string
     */
    public $timezoneId = 'UTC';

    /**
     * Indicated whether the timezone is in DST or not
     * @var boolean
     */
    public $timezoneInDST = false;

    /**
     * Contains the most probable language associated with the selected locale (2 letter code)
     * @var string
     */
    public $language = '';

    /**
     * Which are the most probable timezone candidates for the current setted locale
     * @var array
     */
    protected $_timezoneCandidates = array();

    /**
     * Contains the value of the current setted locale
     * @var string
     */
    protected $_currentLocale = '';

    /**
     * Contains a list of valid timezones
     * @var array
     */
    protected $_validTimeZones = array();

    /**
     * Constructor, will call setLocale internally
     *
     * @param string $setLocale
     */
    public function __construct($setLocale = '')
    {
        $this->setDefault($setLocale);
    }

    /**
     * Returns a string with basic information of this class
     *
     * @return string
     */
    public function __toString()
    {
        return basename(__FILE__) . ' v' . $this->classVersion . ' by Camilo Sperberg - http://unreal4u.com/';
    }

    /**
     * Sets the locale to the given locale
     *
     * This function will also set the "old" setlocale, mainly timezone support for PHP5.3 - PHP5.5
     *
     * @param string $locale Locale we want to set in RFC 4646 format
     * @return string Returns the setted locale
     */
    public function setDefault($locale)
    {
        $result = '';
        if (!empty($locale)) {
            $locale = \Locale::parseLocale($locale);
            $locale = \Locale::composeLocale($locale);
            \Locale::setDefault($locale);
            $result = $this->getDefault();
            $this->_setOptions();
        }

        return $result;
    }

    /**
     * Gets the default setted locale
     */
    public function getDefault()
    {
        $this->_currentLocale = \Locale::getDefault();
        return $this->_currentLocale;
    }

    /**
     * Sets some options
     *
     * @param string $locale

There is no parameter named $locale. Was it maybe removed?

     * @return boolean
     */
    private function _setOptions()
    {
        $this->language = \Locale::getPrimaryLanguage($this->_currentLocale);
        $this->_setTimezoneCandidates(\Locale::getRegion($this->_currentLocale));
        return true;
    }

    /**
     * Sends header to browser containing charset and contentType (mandatory)
     *
     * @param string $charset Charset to send to browser. Defaults to UTF-8
     * @param string $contentType ContentType to send to browser. Defaults to text/html
     * @return boolean Returns true if headers could be sent, false otherwise
     */
    public function sendHeaders($charset = 'UTF-8', $contentType = 'text/html')
    {
        $return = '';

        if (!headers_sent() && !empty($contentType)) {
            $headerString = sprintf('Content-type: %s', $contentType);
            if (!empty($charset)) {
                $headerString .= sprintf('; charset=' . $charset);
            }
            header($headerString);
            $return = $headerString;
        }

        return $return;
    }

    /**
     * Detects on basis of the browser settings which locale we should apply
     *
     * @return string Returns the setted locale
     */
    public function autodetectLocale()
    {
        if (!empty($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
            $this->setDefault(\Locale::acceptFromHttp($_SERVER['HTTP_ACCEPT_LANGUAGE']));
        }

        return $this->_currentLocale;
    }

    /**
     * Applies simple rules to print a number
     *
     * @link http://www.php.net/manual/en/class.numberformatter.php#intl.numberformatter-constants.unumberformatstyle
     *
     * @param float $value
     * @param constant $type One of the accepted constants for numfmt_create (See link)
     * @param int $minimumDigits The minimum significant digits. Defaults to -1, which equals locale default
     * @param int $maximumDigits The maximum significant digits. Defaults to -1, which equals locale default
     * @return string Returns the given value formatted according to current locale
     */
    public function formatNumber($value = 0, $type = 0, $minimumDigits = -1, $maximumDigits = -1)
    {
        if (empty($type)) {
            $type = \NumberFormatter::DECIMAL;
        }

        $numberFormatter = new \NumberFormatter($this->_currentLocale, $type);

        if ($minimumDigits > -1) {
            $numberFormatter->setAttribute(\NumberFormatter::MIN_FRACTION_DIGITS, $minimumDigits);
        }

        if ($maximumDigits > -1) {
            $numberFormatter->setAttribute(\NumberFormatter::MAX_FRACTION_DIGITS, $maximumDigits);
        }
        return $numberFormatter->format($value);
    }

    /**
     * Returns the 3-letter (ISO 4217) currency code of the current locale
     *
     * @return string
     */
    public function getCurrencyISOCode()
    {
        $numberFormatter = new \NumberFormatter($this->_currentLocale, \NumberFormatter::CURRENCY);
        return $numberFormatter->getSymbol(\NumberFormatter::INTL_CURRENCY_SYMBOL);
    }

    /**
     * Returns a intlDateFormatter object
     *
     * @param int $dateConstant
     * @param int $timeConstant
     * @param string $timezone
     * @return \IntlDateFormatter Returns a \IntlDateFormatter object with given options
     */
    private function _getDateObject(
        $dateConstant = \IntlDateFormatter::MEDIUM,
        $timeConstant = \IntlDateFormatter::NONE,
        $timezone = ''
    ) {
        if (!empty($timezone) && $this->isValidTimeZone($timezone)) {
            $timezoneId = $timezone;
        } else {
            $timezoneId = $this->timezoneId;
        }
        $this->setTimezone($timezoneId);

        return \intlDateFormatter::create($this->_currentLocale, $dateConstant, $timeConstant, $this->getTimezoneOffset('eo'));
    }

    /**
     * Returns a formatted medium-typed date
     *
     * @TODO Implement printing locale in another locale
     *
     * @param int $value The UNIX timestamp we want to print. Defaults to current time
     * @param string $timezone The timezone for which we want the information
     * @param int $type The type of date we want to print
     * @param string $locale The locale in which we want the date
     * @return string The formatted date according to current locale settings
     */
    public function formatSimpleDate($value = 0, $timezone = '', $type = \IntlDateFormatter::MEDIUM, $locale = '')

The parameter $locale is not used and could be removed.

This method seems to be duplicated in your project.

    {
        if (empty($value)) {
            $value = time();
        }

        $dateObject = $this->_getDateObject($type, \IntlDateFormatter::NONE, $timezone);
        return $dateObject->format($value);
    }

    /**
     * Returns a formatted medium-typed time
     *
     * @TODO Implement printing locale in another locale
     *
     * @param string $timezone The timezone in which we want to print the time
     * @param int $value The UNIX timestamp we want to print. Defaults to current time
     * @param int $type The type of time we want to print
     * @param string $locale The locale in which we want the time

There is no parameter named $locale. Was it maybe removed?

     * @return string The formatted time according to current locale settings
     */
    public function formatSimpleTime($value = 0, $timezone = '', $type = \intlDateFormatter::MEDIUM)

This method seems to be duplicated in your project.

    {
        if (empty($value)) {
            $value = time();
        }

        $dateObject = $this->_getDateObject(\intlDateFormatter::NONE, $type, $timezone);
        return $dateObject->format($value);
    }

    /**
     * Gets the possible timezone candidates and if only found one, instantiates a DateTimeZone object
     *
     * @param string $region
     */
    private function _setTimezoneCandidates($region = '')
    {
        if (!empty($region)) {
            $this->_timezoneCandidates = \DateTimeZone::listIdentifiers(\DateTimeZone::PER_COUNTRY, $region);
            $this->setTimeZone();
            if (!empty($this->_timezoneCandidates) && count($this->_timezoneCandidates) == 1) {
                $this->setTimezone($this->_timezoneCandidates[0]);
            }
        }
    }

    /**
     * Gets timezone candidates for the current locale
     *
     * @TODO Improve this
     *
     * @return array
     */
    public function getTimeZoneCandidates()
    {
        return $this->_timezoneCandidates;
    }

    /**
     * Verifies that the given timezone exists and sets the timezone to the selected timezone
     *
     * @TODO Verify that the given timezone exists
     *
     * @param string $timezoneName

There is no parameter named $timezoneName. Did you maybe mean $timeZoneName?

     * @return string
     */
    public function setTimezone($timeZoneName = 'UTC')
    {
        if (!$this->isValidTimeZone($timeZoneName)) {
            $timeZoneName = 'UTC';
        }

        $this->timezone = new \DateTimeZone($timeZoneName);
        $this->timezoneId = $this->timezone->getName();
        $transitions = $this->timezone->getTransitions();
        $this->timezoneInDST = $transitions[0]['isdst'];

        return $this->timezoneId;
    }

    /**
     * Checks whether a timezonename is valid or not
     *
     * @param string $timeZoneName
     * @return boolean Returns true if timezone name is valid, false otherwise
     */
    public function isValidTimeZone($timeZoneName = '')
    {
        if (!is_string($timeZoneName)) {
            $timeZoneName = '';
        }

        try {
            new \DateTimeZone($timeZoneName);
            // @TODO Return a timezone instead of true/false?
            return true;
        } catch (\Exception $e) {
            return false;
        }
    }

    /**
     * Gets the offset for the current timezone
     *
     * @param string $unit
     * @param string $when
     * @return string
     */
    public function getTimezoneOffset($unit = 'seconds', $when = 'now')
    {
        $dateTimeObject = new \DateTime($when, $this->timezone);
        $return = $dateTimeObject->getOffset();

        switch ($unit) {
            case 'minutes':
                $return = $return / 60;
                break;
            case 'hours':
                $return = $return / 60 / 60;
                break;
            case 'z':

This code seems to be duplicated across your project.

                $sign = '+';
                if ($return < 0) {
                    $sign = '-';
                }
                $return = $sign . str_pad(gmdate("Hi", abs($return)), 4, '0', STR_PAD_LEFT);
                break;
            case 'eo': // Explicit offset, almost the same as the above, but in a slightly different format

This code seems to be duplicated across your project.

                $sign = '+';
                if ($return < 0) {
                    $sign = '-';
                }
                $return = 'GMT'.$sign . str_pad(gmdate("H:i", abs($return)), 4, '0', STR_PAD_LEFT);
                break;
        }

        return (string)$return;
    }
}