Source\Language\Locale

Complexity

Total Complexity

38

Size/Duplication

Total Lines	273
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	setTranslation()	0	3	1
A	hasTranslation()	0	11	4
A	translate()	0	25	4
A	detectLocale()	0	23	6
A	getTranslation()	0	11	4
A	init()	0	21	5
A	get()	0	3	1
A	getDefault()	0	3	1
A	initLocale()	0	9	3
A	set()	0	3	1
A	setDefault()	0	3	1
A	getTranslationKey()	0	17	4
A	loadTranslation()	0	8	3

<?php

namespace Source\Language;

abstract class Locale
{
    /**
     * Store the transaltion for specific languages
     *
     * @var array $translation
     */
    private static $translation = [];

    /**
     * Current locale
     *
     * @var string $locale
     */
    private static $locale;

    /**
     * Default locale
     *
     * @var string $defaultLocale
     */
    private static $defaultLocale = DEFAULT_COUNTRY;

    /**
     * Lang default dir
     *
     * @var string $localeDir
     */
    private static $localeDir = __DIR__ . '/Translation';

    /**
     * Get the Default locale
     *
     * @return string
     */
    final public static function getDefault(): string
    {
        return self::$defaultLocale;
    }

    /**
     * Set the default locale
     *
     * @return void
     */
    final private static function setDefault(): void
    {
        self::$locale = self::$defaultLocale;
    }

    /**
     * Get the user define locale
     *
     * @return string
     */
    final public static function get(): ?string
    {
        return self::$locale;
    }

    /**
     * Set the user define localte
     *
     * @param string $locale
     * @return void
     */
    final public static function set($locale = null): void
    {
        self::$locale = $locale;
    }

    /**
     * Determine if transltion exist or translation key exist
     *
     * @param string $locale
     * @param string $key
     * @return bool
     */
    final public static function hasTranslation($locale, $key = null): bool
    {
        if (null == $key && isset(self::$translation[$locale])) {

It seems like you are loosely comparing $key of type null|string against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

            return true;
        }

        if (isset(self::$translation[$locale][$key])) {
            return true;
        }

        return false;
    }

    /**
     * Get the transltion for required locale or transtion for key
     *
     * @param string $locale
     * @param string $key
     * @return string|array
     */
    final public static function getTranslation($locale, $key = null)
    {
        if (null == $key && self::hasTranslation($locale)) {

It seems like you are loosely comparing $key of type null|string against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

            return self::$translation[$locale];
        }

        if (self::hasTranslation($locale, $key)) {
            return self::$translation[$locale][$key];
        }

        return [];
    }

    /**
     * Get the transltion for required locale or transtion for key
     *
     * @param string $key
     * @return null|string
     */
    final public static function getTranslationKey(string $key): ?string
    {
        if (self::hasTranslation(self::$locale, $key)) {
            return self::getTranslation(self::$locale, $key);
        }

        if (self::$locale === self::$defaultLocale) {
            return null;
        }

        self::loadTranslation(self::$defaultLocale);

        if (!self::hasTranslation(self::$defaultLocale, $key)) {
            return null;
        }

        $translation = self::getTranslation(self::$defaultLocale, $key);

The assignment to $translation is dead and can be removed.

    }

    /**
     * Set the transtion for required locale
     *
     * @param string $locale Language code
     * @param string $trans translations array
     * @return void
     */
    final private static function setTranslation($locale, $trans = []): void
    {
        self::$translation[$locale] = $trans;
    }

    /**
     * Load a Transtion into array
     *
     * @return void
     */
    final private static function loadTranslation($locale = null, $force = false): void
    {
        if ($locale == null) {
            $locale = self::$locale;
        }

        if (!self::hasTranslation($locale)) {
            self::setTranslation($locale, include(sprintf('%s/%s.php', self::$localeDir, COUNTRY_TO_LANG[self::$locale])));
        }
    }

    /**
     * Initialize locale
     *
     * @param string $locale
     * @return void
     */
    final public static function init($locale = null, $defaultLocale = null): void

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

    {
        self::initLocale();

        if (self::$locale != null) {
            return;
        }

        if (
            $locale == null

It seems like you are loosely comparing $locale of type null|string against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

            || (!preg_match('#^[a-z]+_[a-zA-Z_]+$#', $locale)
                && !preg_match('#^[a-z]+_[a-zA-Z]+_[a-zA-Z_]+$#', $locale)
            )
        ) {
            self::detectLocale();
            self::initLocale();
            return;
        }

        self::$locale = $locale;
        self::initLocale();
    }

    /**
     * Attempt to autodetect locale
     *
     * @return void
     */
    final private static function detectLocale(): void
    {
        if (!function_exists('geoip_country_code_by_name')) {
            error_log('a funcao de GeoIP nao foi encontrada!');
            self::setDefault();
            return;
        }

        if (!isset($_SERVER['REMOTE_ADDR'])) {
            error_log('src_ip não foi encontrado!');
            self::setDefault();
            return;
        }

        // GeoIP
        $country = geoip_country_code_by_name($_SERVER['REMOTE_ADDR']);

        if ($country) {
            self::$locale = isset(COUNTRY_TO_LANG[$country]) ? $country : null;
        }

        if (empty(self::$locale)) {
            self::setDefault();
        }
    }

    /**
     * Check if config for selected locale exists
     *
     * @return void
     */
    final private static function initLocale(): void
    {
        if (null === self::$locale) {

The condition null === self::locale is always false.

            self::detectLocale();
        }

        if (!file_exists(sprintf('%s/%s.php', self::$localeDir, @COUNTRY_TO_LANG[self::$locale]))) {
            error_log(sprintf('lang: %s of country %s, does not exists!', @COUNTRY_TO_LANG[self::$locale] ?? 'undefined', self::$locale));
            self::setDefault();
        }
    }

    /**
     * Translate a key
     *
     * @param string Key to be translated
     * @param string optional arguments

The type Source\Language\optional was not found. Maybe you did not declare it correctly or list all dependencies?

     * @return string
     */
    final public static function translate($key): string
    {
        self::init();
        self::loadTranslation(self::$locale);

        $translation = self::getTranslationKey($key);

        if (empty($translation)) {
            return $key;
        }

        if (false === strpos($translation, '{arg:')) {
            return $translation;
        }

        // Replace arguments
        $replace = [];
        $args = func_get_args();

        for ($i = 1, $max = count($args); $i < $max; $i++) {
            $replace['{arg:' . $i . '}'] = $args[$i];
        }

        // Interpolate replacement values into the messsage then return
        return strtr($translation, $replace);
    }
}