[李景山php]每天TP5-20170107|thinkphp5-Lang.php

<?php
// +----------------------------------------------------------------------
// | ThinkPHP [ WE CAN DO IT JUST THINK ]
// +----------------------------------------------------------------------
// | Copyright (c) 2006~2016 http://thinkphp.cn All rights reserved.
// +----------------------------------------------------------------------
// | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
// +----------------------------------------------------------------------
// | Author: liu21st <liu21st@gmail.com>
// +----------------------------------------------------------------------

namespace think;

use think\App;
use think\Cookie;
use think\Log;
// 使用 app \ cookie\ log 类
class Lang
{// 语言 类
    // 语言数据
    private static $lang = [];// 语言数据
    // 语言作用域
    private static $range = 'zh-cn';// 语言作用域 语言类型
    // 语言自动侦测的变量
    protected static $langDetectVar = 'lang'; // 自动侦测变量
    // 语言Cookie变量
    protected static $langCookieVar = 'think_var'; // 语言 cookie 变量
    // 允许语言列表
    protected static $allowLangList = [];// 允许语言列表

    // 设定当前的语言
    public static function range($range = '')// 设定 当前的 语言
    {// 设置 或者 是索取
        if ('' == $range) {
            return self::$range;
        } else {
            self::$range = $range;
        }
    }

    /**
     * 设置语言定义(不区分大小写)
     * @param string|array  $name 语言变量
     * @param string        $value 语言值
     * @param string        $range 语言作用域
     * @return mixed
     */
    public static function set($name, $value = null, $range = '')
    {
        $range = $range ?: self::$range;// 设置语言 范围 ，范围 内部
        // 批量定义
        if (!isset(self::$lang[$range])) {// 获取语言 设置
            self::$lang[$range] = [];
        }
        if (is_array($name)) {// 支持 数组设置 同时 也支持 字符串 的设置
            return self::$lang[$range] = array_change_key_case($name) + self::$lang[$range];// 进行语言变量设置
        } else {
            return self::$lang[$range][strtolower($name)] = $value;// 单独设置
        }
    }

    /**
     * 加载语言定义(不区分大小写)
     * @param string $file 语言文件
     * @param string $range 语言作用域
     * @return mixed
     */
    public static function load($file, $range = '')
    {
        $range = $range ?: self::$range;// 范围
        if (!isset(self::$lang[$range])) {// 语言定义数据
            self::$lang[$range] = [];
        }
        // 批量定义
        if (is_string($file)) {// 文件 字符串 转数组
            $file = [$file];
        }
        $lang = [];// 语言 定义 临时仓库
        foreach ($file as $_file) {
            if (is_file($_file)) {// 如果是文件
                // 记录加载信息
                App::$debug && Log::record('[ LANG ] ' . $_file, 'info');// 调试 并且 记录 加载信息
                $_lang = include $_file;// 临时数据
            } else {
                $_lang = [];
            }
            $lang = array_change_key_case($_lang) + $lang; // 拼接字符串 + 号的方式，有什么特别的吗？ array_merge不行吗
        }
        if (!empty($lang)) {// 不为空， 拼接
            self::$lang[$range] = $lang + self::$lang[$range];
        }
        return self::$lang[$range];// 返回定义数组
    }

    /**
     * 获取语言定义(不区分大小写)
     * @param string|null   $name 语言变量
     * @param array         $vars 变量替换
     * @param string        $range 语言作用域
     * @return mixed
     */
    public static function has($name, $range = '')// 检测 当前的转义 是否存在
    {
        $range = $range ?: self::$range;
        return isset(self::$lang[$range][strtolower($name)]);
    }

    /**
     * 获取语言定义(不区分大小写)
     * @param string|null   $name 语言变量
     * @param array         $vars 变量替换
     * @param string        $range 语言作用域
     * @return mixed
     */
    public static function get($name = null, $vars = [], $range = '')
    {
        $range = $range ?: self::$range;
        // 空参数返回所有定义
        if (empty($name)) {// 为空，返回 当前全部语言定义
            return self::$lang[$range];
        }
        $key   = strtolower($name);// 找到key
        $value = isset(self::$lang[$range][$key]) ? self::$lang[$range][$key] : $name;// 值是输入的信息？ 开玩笑吗？

        // 变量解析
        if (!empty($vars) && is_array($vars)) {// 变量 解析 获取数据不为空
            /**
             * Notes:
             * 为了检测的方便，数字索引的判断仅仅是参数数组的第一个元素的key为数字0
             * 数字索引采用的是系统的 sprintf 函数替换，用法请参考 sprintf 函数
             */
            if (key($vars) === 0) {
                // 数字索引解析
                array_unshift($vars, $value);// 这个要加强 array_unshift array_change_key_case
                $value = call_user_func_array('sprintf', $vars);// 格式化 输出
            } else {
                // 关联索引解析
                $replace = array_keys($vars);
                foreach ($replace as &$v) {
                    $v = "{:{$v}}";
                }
                $value = str_replace($replace, $vars, $value);// 临时替换数据
            }

        }
        return $value;
    }

    /**
     * 自动侦测设置获取语言选择
     * @return string
     */
    public static function detect()
    {
        // 自动侦测设置获取语言选择
        $langSet = '';// 默认设置为空
        if (isset($_GET[self::$langDetectVar])) {// url 设置
            // url中设置了语言变量
            $langSet = strtolower($_GET[self::$langDetectVar]);
            Cookie::set(self::$langCookieVar, $langSet, 3600);
        } elseif (Cookie::get(self::$langCookieVar)) {// 默认的cookie 设置
            // 获取上次用户的选择
            $langSet = strtolower(Cookie::get(self::$langCookieVar));
        } elseif (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {// 浏览器 设置
            // 自动侦测浏览器语言
            preg_match('/^([a-z\d\-]+)/i', $_SERVER['HTTP_ACCEPT_LANGUAGE'], $matches);
            $langSet = strtolower($matches[1]);
            Cookie::set(self::$langCookieVar, $langSet, 3600);
        }
        if (empty(self::$allowLangList) || in_array($langSet, self::$allowLangList)) {// 默认设置 返回数据
            // 合法的语言
            self::$range = $langSet ?: self::$range;
        }
        if ('zh-hans-cn' == self::$range) {// 强制 转换 一个参数
            self::$range = 'zh-cn';
        }
        return self::$range;
    }

    /**
     * 设置语言自动侦测的变量
     * @param string $var 变量名称
     * @return void
     */
    public static function setLangDetectVar($var)// 变量设置
    {
        self::$langDetectVar = $var;
    }

    /**
     * 设置语言的cookie保存变量
     * @param string $var 变量名称
     * @return void
     */
    public static function setLangCookieVar($var)// cookie变量
    {
        self::$langCookieVar = $var;
    }

    /**
     * 设置允许的语言列表
     * @param array $list 语言列表
     * @return void
     */
    public static function setAllowLangList($list)// 允许列表
    {
        self::$allowLangList = $list;
    }
}