PHPCI\Helper\Lang

Complexity

Total Complexity

27

Size/Duplication

Total Lines	185
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

18.84%

Importance

Changes	1
Bugs	1	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	get()	0	12	2
A	out()	0	4	1
A	getLanguage()	0	4	1
A	setLanguage()	0	11	2
A	getLanguageOptions()	0	12	2
A	getStrings()	0	4	1
D	init()	0	33	9
B	loadLanguage()	0	16	5
A	loadAvailableLanguages()	0	9	3
A	formatDateTime()	0	9	1

<?php
/**
 * PHPCI - Continuous Integration for PHP.
 *
 * @copyright    Copyright 2014, Block 8 Limited.
 * @license      https://github.com/Block8/PHPCI/blob/master/LICENSE.md
 *
 * @link         https://www.phptesting.org/
 */

namespace PHPCI\Helper;

use b8\Config;

/**
 * Languages Helper Class - Handles loading strings files and the strings within them.
 */
class Lang
{
    protected static $language = null;
    protected static $strings = array();
    protected static $languages = array();

    /**
     * Get a specific string from the language file.
     *
     * @param string $string
     *
     * @return mixed|string
     */
    public static function get($string)
    {
        $vars = func_get_args();

        if (array_key_exists($string, self::$strings)) {
            $vars[0] = self::$strings[$string];

            return call_user_func_array('sprintf', $vars);
        }

        return '%%MISSING STRING: '.$string.'%%';
    }

    /**
     * Output a specific string from the language file.
     */
    public static function out()
    {
        echo call_user_func_array(array('PHPCI\Helper\Lang', 'get'), func_get_args());
    }

    /**
     * Get the currently active language.
     *
     * @return string
     */
    public static function getLanguage()
    {
        return self::$language;
    }

    /**
     * Try and load a language, and if successful, set it for use throughout the system.
     *
     * @param $language
     *
     * @return bool
     */
    public static function setLanguage($language)
    {
        if (in_array($language, self::$languages)) {
            self::$language = $language;
            self::$strings = self::loadLanguage();

It seems like self::loadLanguage() can be null. However, the property $strings is declared as array. Maybe change the type of the property to array|null or add a type check?

            return true;
        }

        return false;
    }

    /**
     * Return a list of available languages and their names.
     *
     * @return array
     */
    public static function getLanguageOptions()
    {
        $languages = array();

        foreach (self::$languages as $language) {
            $strings = array();
            require PHPCI_DIR.'PHPCI/Languages/lang.'.$language.'.php';
            $languages[$language] = $strings['language_name'];
        }

        return $languages;
    }

    /**
     * Get the strings for the currently active language.
     *
     * @return string[]
     */
    public static function getStrings()
    {
        return self::$strings;
    }

    /**
     * Initialise the Language helper, try load the language file for the user's browser or the configured default.
     *
     * @param Config $config
     */
    public static function init(Config $config)

init uses the super-global variable $_COOKIE which is generally not recommended.

init uses the super-global variable $_SERVER which is generally not recommended.

    {
        self::loadAvailableLanguages();

        // Try cookies first:
        if (isset($_COOKIE) && array_key_exists('phpcilang', $_COOKIE) && self::setLanguage($_COOKIE['phpcilang'])) {
            return;
        }

        // Try user language:
        if (isset($_SERVER) && array_key_exists('HTTP_ACCEPT_LANGUAGE', $_SERVER)) {
            $langs = explode(',', $_SERVER['HTTP_ACCEPT_LANGUAGE']);

            foreach ($langs as $lang) {
                $parts = explode(';', $lang);
                $language = strtolower($parts[0]);

                if (self::setLanguage($language)) {
                    return;
                }
            }
        }

        // Try the installation default language:
        $language = $config->get('phpci.basic.language', null);
        if (self::setLanguage($language)) {
            return;
        }

        // Fall back to English:
        self::$language = 'en';
        self::$strings = self::loadLanguage();

It seems like self::loadLanguage() can be null. However, the property $strings is declared as array. Maybe change the type of the property to array|null or add a type check?

    }

    /**
     * Load a specific language file.
     *
     * @return string[]|null
     */
    protected static function loadLanguage()
    {
        $langFile = PHPCI_DIR.'PHPCI/Languages/lang.'.self::$language.'.php';

        if (!file_exists($langFile)) {
            return;
        }

        require $langFile;

        if (is_null($strings) || !is_array($strings) || !count($strings)) {

The variable $strings does not exist. Did you forget to declare it?

            return;
        }

        return $strings;
    }

    /**
     * Load the names of all available languages.
     */
    protected static function loadAvailableLanguages()
    {
        $matches = array();
        foreach (glob(PHPCI_DIR.'PHPCI/Languages/lang.*.php') as $file) {
            if (preg_match('/lang\.([a-z]{2}\-?[a-z]*)\.php/', $file, $matches)) {
                self::$languages[] = $matches[1];
            }
        }
    }

    /**
     * Create a time tag for localization.
     *
     * See http://momentjs.com/docs/#/displaying/format/ for a list of supported formats.
     *
     * @param \DateTime $dateTime The dateTime to represent.
     * @param string    $format   The moment.js format to use.
     *
     * @return string The formatted tag.
     */
    public static function formatDateTime(\DateTime $dateTime, $format = 'lll')
    {
        return sprintf(
            '<time datetime="%s" data-format="%s">%s</time>',
            $dateTime->format(\DateTime::ISO8601),
            $format,
            $dateTime->format(\DateTime::RFC2822)
        );
    }
}