Fixed namespaces (PHPCI -> PHPCensor)

src/PHPCensor/Helper/Lang.php

@@ -0,0 +1,220 @@
+<?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 PHPCensor\Helper;
+
+use b8\Config;
+
+/**
+ * Languages Helper Class - Handles loading strings files and the strings within them.
+ *
+ * @package PHPCI\Helper
+ */
+class Lang
+{
+    /**
+     * @var string
+     */
+    protected static $language  = null;
+
+    /**
+     * @var array
+     */
+    protected static $languages = [];
+
+    /**
+     * @var array
+     */
+    protected static $strings = [];
+
+    /**
+     * @var array
+     */
+    protected static $en_strings = [];
+
+    /**
+     * Get a specific string from the language file.
+     *
+     * @param $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);
+        } elseif ('en' !== self::$language && array_key_exists($string, self::$en_strings)) {
+            $vars[0] = self::$en_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()
+    {
+        print call_user_func_array(['PHPCensor\Helper\Lang', 'get'], func_get_args());
+    }
+
+    /**
+     * Get the currently active language.
+     *
+     * @return string|null
+     */
+    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();
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Return a list of available languages and their names.
+     *
+     * @return array
+     */
+    public static function getLanguageOptions()
+    {
+        $languages = [];
+        foreach (self::$languages as $language) {
+            $strings = include_once(PHPCI_DIR . 'Languages' . DIRECTORY_SEPARATOR . 'lang.' . $language . '.php');
+            $languages[$language] = !empty($strings['language_name']) ? $strings['language_name'] : $language;
+        }
+
+        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)
+    {
+        self::$en_strings = self::loadLanguage('en');
+        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();
+    }
+
+    /**
+     * Load a specific language file.
+     *
+     * @param string $language
+     *
+     * @return string[]|null
+     */
+    protected static function loadLanguage($language = null)
+    {
+        $language = $language ? $language : self::$language;
+        $langFile = PHPCI_DIR . 'Languages' . DIRECTORY_SEPARATOR . 'lang.' . $language . '.php';
+
+        if (!file_exists($langFile)) {
+            return null;
+        }
+
+        $strings = include($langFile);
+        if (is_null($strings) || !is_array($strings) || !count($strings)) {
+            return null;
+        }
+        
+        return $strings;
+    }
+
+    /**
+     * Load the names of all available languages.
+     */
+    protected static function loadAvailableLanguages()
+    {
+        $matches = [];
+        foreach (glob(PHPCI_DIR . 'Languages' . DIRECTORY_SEPARATOR . '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)
+        );
+    }
+}