Lang.php 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294
  1. <?php
  2. // +----------------------------------------------------------------------
  3. // | ThinkPHP [ WE CAN DO IT JUST THINK ]
  4. // +----------------------------------------------------------------------
  5. // | Copyright (c) 2006~2021 http://thinkphp.cn All rights reserved.
  6. // +----------------------------------------------------------------------
  7. // | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
  8. // +----------------------------------------------------------------------
  9. // | Author: liu21st <liu21st@gmail.com>
  10. // +----------------------------------------------------------------------
  11. declare (strict_types = 1);
  12. namespace think;
  13. /**
  14. * 多语言管理类
  15. * @package think
  16. */
  17. class Lang
  18. {
  19. /**
  20. * 配置参数
  21. * @var array
  22. */
  23. protected $config = [
  24. // 默认语言
  25. 'default_lang' => 'zh-cn',
  26. // 允许的语言列表
  27. 'allow_lang_list' => [],
  28. // 是否使用Cookie记录
  29. 'use_cookie' => true,
  30. // 扩展语言包
  31. 'extend_list' => [],
  32. // 多语言cookie变量
  33. 'cookie_var' => 'think_lang',
  34. // 多语言header变量
  35. 'header_var' => 'think-lang',
  36. // 多语言自动侦测变量名
  37. 'detect_var' => 'lang',
  38. // Accept-Language转义为对应语言包名称
  39. 'accept_language' => [
  40. 'zh-hans-cn' => 'zh-cn',
  41. ],
  42. // 是否支持语言分组
  43. 'allow_group' => false,
  44. ];
  45. /**
  46. * 多语言信息
  47. * @var array
  48. */
  49. private $lang = [];
  50. /**
  51. * 当前语言
  52. * @var string
  53. */
  54. private $range = 'zh-cn';
  55. /**
  56. * 构造方法
  57. * @access public
  58. * @param array $config
  59. */
  60. public function __construct(array $config = [])
  61. {
  62. $this->config = array_merge($this->config, array_change_key_case($config));
  63. $this->range = $this->config['default_lang'];
  64. }
  65. public static function __make(Config $config)
  66. {
  67. return new static($config->get('lang'));
  68. }
  69. /**
  70. * 设置当前语言
  71. * @access public
  72. * @param string $lang 语言
  73. * @return void
  74. */
  75. public function setLangSet(string $lang): void
  76. {
  77. $this->range = $lang;
  78. }
  79. /**
  80. * 获取当前语言
  81. * @access public
  82. * @return string
  83. */
  84. public function getLangSet(): string
  85. {
  86. return $this->range;
  87. }
  88. /**
  89. * 获取默认语言
  90. * @access public
  91. * @return string
  92. */
  93. public function defaultLangSet()
  94. {
  95. return $this->config['default_lang'];
  96. }
  97. /**
  98. * 加载语言定义(不区分大小写)
  99. * @access public
  100. * @param string|array $file 语言文件
  101. * @param string $range 语言作用域
  102. * @return array
  103. */
  104. public function load($file, $range = ''): array
  105. {
  106. $range = $range ?: $this->range;
  107. if (!isset($this->lang[$range])) {
  108. $this->lang[$range] = [];
  109. }
  110. $lang = [];
  111. foreach ((array) $file as $name) {
  112. if (is_file($name)) {
  113. $result = $this->parse($name);
  114. $lang = array_change_key_case($result) + $lang;
  115. }
  116. }
  117. if (!empty($lang)) {
  118. $this->lang[$range] = $lang + $this->lang[$range];
  119. }
  120. return $this->lang[$range];
  121. }
  122. /**
  123. * 解析语言文件
  124. * @access protected
  125. * @param string $file 语言文件名
  126. * @return array
  127. */
  128. protected function parse(string $file): array
  129. {
  130. $type = pathinfo($file, PATHINFO_EXTENSION);
  131. switch ($type) {
  132. case 'php':
  133. $result = include $file;
  134. break;
  135. case 'yml':
  136. case 'yaml':
  137. if (function_exists('yaml_parse_file')) {
  138. $result = yaml_parse_file($file);
  139. }
  140. break;
  141. case 'json':
  142. $data = file_get_contents($file);
  143. if (false !== $data) {
  144. $data = json_decode($data, true);
  145. if (json_last_error() === JSON_ERROR_NONE) {
  146. $result = $data;
  147. }
  148. }
  149. break;
  150. }
  151. return isset($result) && is_array($result) ? $result : [];
  152. }
  153. /**
  154. * 判断是否存在语言定义(不区分大小写)
  155. * @access public
  156. * @param string|null $name 语言变量
  157. * @param string $range 语言作用域
  158. * @return bool
  159. */
  160. public function has(string $name, string $range = ''): bool
  161. {
  162. $range = $range ?: $this->range;
  163. if ($this->config['allow_group'] && strpos($name, '.')) {
  164. [$name1, $name2] = explode('.', $name, 2);
  165. return isset($this->lang[$range][strtolower($name1)][$name2]);
  166. }
  167. return isset($this->lang[$range][strtolower($name)]);
  168. }
  169. /**
  170. * 获取语言定义(不区分大小写)
  171. * @access public
  172. * @param string|null $name 语言变量
  173. * @param array $vars 变量替换
  174. * @param string $range 语言作用域
  175. * @return mixed
  176. */
  177. public function get(string $name = null, array $vars = [], string $range = '')
  178. {
  179. $range = $range ?: $this->range;
  180. // 空参数返回所有定义
  181. if (is_null($name)) {
  182. return $this->lang[$range] ?? [];
  183. }
  184. if ($this->config['allow_group'] && strpos($name, '.')) {
  185. [$name1, $name2] = explode('.', $name, 2);
  186. $value = $this->lang[$range][strtolower($name1)][$name2] ?? $name;
  187. } else {
  188. $value = $this->lang[$range][strtolower($name)] ?? $name;
  189. }
  190. // 变量解析
  191. if (!empty($vars) && is_array($vars)) {
  192. /**
  193. * Notes:
  194. * 为了检测的方便,数字索引的判断仅仅是参数数组的第一个元素的key为数字0
  195. * 数字索引采用的是系统的 sprintf 函数替换,用法请参考 sprintf 函数
  196. */
  197. if (key($vars) === 0) {
  198. // 数字索引解析
  199. array_unshift($vars, $value);
  200. $value = call_user_func_array('sprintf', $vars);
  201. } else {
  202. // 关联索引解析
  203. $replace = array_keys($vars);
  204. foreach ($replace as &$v) {
  205. $v = "{:{$v}}";
  206. }
  207. $value = str_replace($replace, $vars, $value);
  208. }
  209. }
  210. return $value;
  211. }
  212. /**
  213. * 自动侦测设置获取语言选择
  214. * @access public
  215. * @param Request $request
  216. * @return string
  217. */
  218. public function detect(Request $request): string
  219. {
  220. // 自动侦测设置获取语言选择
  221. $langSet = '';
  222. if ($request->get($this->config['detect_var'])) {
  223. // url中设置了语言变量
  224. $langSet = strtolower($request->get($this->config['detect_var']));
  225. } elseif ($request->header($this->config['header_var'])) {
  226. // Header中设置了语言变量
  227. $langSet = strtolower($request->header($this->config['header_var']));
  228. } elseif ($request->cookie($this->config['cookie_var'])) {
  229. // Cookie中设置了语言变量
  230. $langSet = strtolower($request->cookie($this->config['cookie_var']));
  231. } elseif ($request->server('HTTP_ACCEPT_LANGUAGE')) {
  232. // 自动侦测浏览器语言
  233. $match = preg_match('/^([a-z\d\-]+)/i', $request->server('HTTP_ACCEPT_LANGUAGE'), $matches);
  234. if ($match) {
  235. $langSet = strtolower($matches[1]);
  236. if (isset($this->config['accept_language'][$langSet])) {
  237. $langSet = $this->config['accept_language'][$langSet];
  238. }
  239. }
  240. }
  241. if (empty($this->config['allow_lang_list']) || in_array($langSet, $this->config['allow_lang_list'])) {
  242. // 合法的语言
  243. $this->range = $langSet;
  244. }
  245. return $this->range;
  246. }
  247. /**
  248. * 保存当前语言到Cookie
  249. * @access public
  250. * @param Cookie $cookie Cookie对象
  251. * @return void
  252. */
  253. public function saveToCookie(Cookie $cookie)
  254. {
  255. if ($this->config['use_cookie']) {
  256. $cookie->set($this->config['cookie_var'], $this->range);
  257. }
  258. }
  259. }