590 líneas
17 KiB

  1. <?php
  2. // +----------------------------------------------------------------------
  3. // | ThinkPHP [ WE CAN DO IT JUST THINK ]
  4. // +----------------------------------------------------------------------
  5. // | Copyright (c) 2006~2018 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. //------------------------
  12. // ThinkPHP 助手函数
  13. //-------------------------
  14. use think\Cache;
  15. use think\Config;
  16. use think\Cookie;
  17. use think\Db;
  18. use think\Debug;
  19. use think\exception\HttpException;
  20. use think\exception\HttpResponseException;
  21. use think\Lang;
  22. use think\Loader;
  23. use think\Log;
  24. use think\Model;
  25. use think\Request;
  26. use think\Response;
  27. use think\Session;
  28. use think\Url;
  29. use think\View;
  30. if (!function_exists('load_trait')) {
  31. /**
  32. * 快速导入Traits PHP5.5以上无需调用
  33. * @param string $class trait库
  34. * @param string $ext 类库后缀
  35. * @return boolean
  36. */
  37. function load_trait($class, $ext = EXT)
  38. {
  39. return Loader::import($class, TRAIT_PATH, $ext);
  40. }
  41. }
  42. if (!function_exists('exception')) {
  43. /**
  44. * 抛出异常处理
  45. *
  46. * @param string $msg 异常消息
  47. * @param integer $code 异常代码 默认为0
  48. * @param string $exception 异常类
  49. *
  50. * @throws Exception
  51. */
  52. function exception($msg, $code = 0, $exception = '')
  53. {
  54. $e = $exception ?: '\think\Exception';
  55. throw new $e($msg, $code);
  56. }
  57. }
  58. if (!function_exists('debug')) {
  59. /**
  60. * 记录时间(微秒)和内存使用情况
  61. * @param string $start 开始标签
  62. * @param string $end 结束标签
  63. * @param integer|string $dec 小数位 如果是m 表示统计内存占用
  64. * @return mixed
  65. */
  66. function debug($start, $end = '', $dec = 6)
  67. {
  68. if ('' == $end) {
  69. Debug::remark($start);
  70. } else {
  71. return 'm' == $dec ? Debug::getRangeMem($start, $end) : Debug::getRangeTime($start, $end, $dec);
  72. }
  73. }
  74. }
  75. if (!function_exists('lang')) {
  76. /**
  77. * 获取语言变量值
  78. * @param string $name 语言变量名
  79. * @param array $vars 动态变量值
  80. * @param string $lang 语言
  81. * @return mixed
  82. */
  83. function lang($name, $vars = [], $lang = '')
  84. {
  85. return Lang::get($name, $vars, $lang);
  86. }
  87. }
  88. if (!function_exists('config')) {
  89. /**
  90. * 获取和设置配置参数
  91. * @param string|array $name 参数名
  92. * @param mixed $value 参数值
  93. * @param string $range 作用域
  94. * @return mixed
  95. */
  96. function config($name = '', $value = null, $range = '')
  97. {
  98. if (is_null($value) && is_string($name)) {
  99. return 0 === strpos($name, '?') ? Config::has(substr($name, 1), $range) : Config::get($name, $range);
  100. } else {
  101. return Config::set($name, $value, $range);
  102. }
  103. }
  104. }
  105. if (!function_exists('input')) {
  106. /**
  107. * 获取输入数据 支持默认值和过滤
  108. * @param string $key 获取的变量名
  109. * @param mixed $default 默认值
  110. * @param string $filter 过滤方法
  111. * @return mixed
  112. */
  113. function input($key = '', $default = null, $filter = '')
  114. {
  115. if (0 === strpos($key, '?')) {
  116. $key = substr($key, 1);
  117. $has = true;
  118. }
  119. if ($pos = strpos($key, '.')) {
  120. // 指定参数来源
  121. list($method, $key) = explode('.', $key, 2);
  122. if (!in_array($method, ['get', 'post', 'put', 'patch', 'delete', 'route', 'param', 'request', 'session', 'cookie', 'server', 'env', 'path', 'file'])) {
  123. $key = $method . '.' . $key;
  124. $method = 'param';
  125. }
  126. } else {
  127. // 默认为自动判断
  128. $method = 'param';
  129. }
  130. if (isset($has)) {
  131. return request()->has($key, $method, $default);
  132. } else {
  133. return request()->$method($key, $default, $filter);
  134. }
  135. }
  136. }
  137. if (!function_exists('widget')) {
  138. /**
  139. * 渲染输出Widget
  140. * @param string $name Widget名称
  141. * @param array $data 传入的参数
  142. * @return mixed
  143. */
  144. function widget($name, $data = [])
  145. {
  146. return Loader::action($name, $data, 'widget');
  147. }
  148. }
  149. if (!function_exists('model')) {
  150. /**
  151. * 实例化Model
  152. * @param string $name Model名称
  153. * @param string $layer 业务层名称
  154. * @param bool $appendSuffix 是否添加类名后缀
  155. * @return \think\Model
  156. */
  157. function model($name = '', $layer = 'model', $appendSuffix = false)
  158. {
  159. return Loader::model($name, $layer, $appendSuffix);
  160. }
  161. }
  162. if (!function_exists('validate')) {
  163. /**
  164. * 实例化验证器
  165. * @param string $name 验证器名称
  166. * @param string $layer 业务层名称
  167. * @param bool $appendSuffix 是否添加类名后缀
  168. * @return \think\Validate
  169. */
  170. function validate($name = '', $layer = 'validate', $appendSuffix = false)
  171. {
  172. return Loader::validate($name, $layer, $appendSuffix);
  173. }
  174. }
  175. if (!function_exists('db')) {
  176. /**
  177. * 实例化数据库类
  178. * @param string $name 操作的数据表名称(不含前缀)
  179. * @param array|string $config 数据库配置参数
  180. * @param bool $force 是否强制重新连接
  181. * @return \think\db\Query
  182. */
  183. function db($name = '', $config = [], $force = false)
  184. {
  185. return Db::connect($config, $force)->name($name);
  186. }
  187. }
  188. if (!function_exists('controller')) {
  189. /**
  190. * 实例化控制器 格式:[模块/]控制器
  191. * @param string $name 资源地址
  192. * @param string $layer 控制层名称
  193. * @param bool $appendSuffix 是否添加类名后缀
  194. * @return \think\Controller
  195. */
  196. function controller($name, $layer = 'controller', $appendSuffix = false)
  197. {
  198. return Loader::controller($name, $layer, $appendSuffix);
  199. }
  200. }
  201. if (!function_exists('action')) {
  202. /**
  203. * 调用模块的操作方法 参数格式 [模块/控制器/]操作
  204. * @param string $url 调用地址
  205. * @param string|array $vars 调用参数 支持字符串和数组
  206. * @param string $layer 要调用的控制层名称
  207. * @param bool $appendSuffix 是否添加类名后缀
  208. * @return mixed
  209. */
  210. function action($url, $vars = [], $layer = 'controller', $appendSuffix = false)
  211. {
  212. return Loader::action($url, $vars, $layer, $appendSuffix);
  213. }
  214. }
  215. if (!function_exists('import')) {
  216. /**
  217. * 导入所需的类库 同java的Import 本函数有缓存功能
  218. * @param string $class 类库命名空间字符串
  219. * @param string $baseUrl 起始路径
  220. * @param string $ext 导入的文件扩展名
  221. * @return boolean
  222. */
  223. function import($class, $baseUrl = '', $ext = EXT)
  224. {
  225. return Loader::import($class, $baseUrl, $ext);
  226. }
  227. }
  228. if (!function_exists('vendor')) {
  229. /**
  230. * 快速导入第三方框架类库 所有第三方框架的类库文件统一放到 系统的Vendor目录下面
  231. * @param string $class 类库
  232. * @param string $ext 类库后缀
  233. * @return boolean
  234. */
  235. function vendor($class, $ext = EXT)
  236. {
  237. return Loader::import($class, VENDOR_PATH, $ext);
  238. }
  239. }
  240. if (!function_exists('dump')) {
  241. /**
  242. * 浏览器友好的变量输出
  243. * @param mixed $var 变量
  244. * @param boolean $echo 是否输出 默认为true 如果为false 则返回输出字符串
  245. * @param string $label 标签 默认为空
  246. * @return void|string
  247. */
  248. function dump($var, $echo = true, $label = null)
  249. {
  250. return Debug::dump($var, $echo, $label);
  251. }
  252. }
  253. if (!function_exists('url')) {
  254. /**
  255. * Url生成
  256. * @param string $url 路由地址
  257. * @param string|array $vars 变量
  258. * @param bool|string $suffix 生成的URL后缀
  259. * @param bool|string $domain 域名
  260. * @return string
  261. */
  262. function url($url = '', $vars = '', $suffix = true, $domain = false)
  263. {
  264. return Url::build($url, $vars, $suffix, $domain);
  265. }
  266. }
  267. if (!function_exists('session')) {
  268. /**
  269. * Session管理
  270. * @param string|array $name session名称,如果为数组表示进行session设置
  271. * @param mixed $value session值
  272. * @param string $prefix 前缀
  273. * @return mixed
  274. */
  275. function session($name, $value = '', $prefix = null)
  276. {
  277. if (is_array($name)) {
  278. // 初始化
  279. Session::init($name);
  280. } elseif (is_null($name)) {
  281. // 清除
  282. Session::clear('' === $value ? null : $value);
  283. } elseif ('' === $value) {
  284. // 判断或获取
  285. return 0 === strpos($name, '?') ? Session::has(substr($name, 1), $prefix) : Session::get($name, $prefix);
  286. } elseif (is_null($value)) {
  287. // 删除
  288. return Session::delete($name, $prefix);
  289. } else {
  290. // 设置
  291. return Session::set($name, $value, $prefix);
  292. }
  293. }
  294. }
  295. if (!function_exists('cookie')) {
  296. /**
  297. * Cookie管理
  298. * @param string|array $name cookie名称,如果为数组表示进行cookie设置
  299. * @param mixed $value cookie值
  300. * @param mixed $option 参数
  301. * @return mixed
  302. */
  303. function cookie($name, $value = '', $option = null)
  304. {
  305. if (is_array($name)) {
  306. // 初始化
  307. Cookie::init($name);
  308. } elseif (is_null($name)) {
  309. // 清除
  310. Cookie::clear($value);
  311. } elseif ('' === $value) {
  312. // 获取
  313. return 0 === strpos($name, '?') ? Cookie::has(substr($name, 1), $option) : Cookie::get($name, $option);
  314. } elseif (is_null($value)) {
  315. // 删除
  316. return Cookie::delete($name);
  317. } else {
  318. // 设置
  319. return Cookie::set($name, $value, $option);
  320. }
  321. }
  322. }
  323. if (!function_exists('cache')) {
  324. /**
  325. * 缓存管理
  326. * @param mixed $name 缓存名称,如果为数组表示进行缓存设置
  327. * @param mixed $value 缓存值
  328. * @param mixed $options 缓存参数
  329. * @param string $tag 缓存标签
  330. * @return mixed
  331. */
  332. function cache($name, $value = '', $options = null, $tag = null)
  333. {
  334. if (is_array($options)) {
  335. // 缓存操作的同时初始化
  336. $cache = Cache::connect($options);
  337. } elseif (is_array($name)) {
  338. // 缓存初始化
  339. return Cache::connect($name);
  340. } else {
  341. $cache = Cache::init();
  342. }
  343. if (is_null($name)) {
  344. return $cache->clear($value);
  345. } elseif ('' === $value) {
  346. // 获取缓存
  347. return 0 === strpos($name, '?') ? $cache->has(substr($name, 1)) : $cache->get($name);
  348. } elseif (is_null($value)) {
  349. // 删除缓存
  350. return $cache->rm($name);
  351. } elseif (0 === strpos($name, '?') && '' !== $value) {
  352. $expire = is_numeric($options) ? $options : null;
  353. return $cache->remember(substr($name, 1), $value, $expire);
  354. } else {
  355. // 缓存数据
  356. if (is_array($options)) {
  357. $expire = isset($options['expire']) ? $options['expire'] : null; //修复查询缓存无法设置过期时间
  358. } else {
  359. $expire = is_numeric($options) ? $options : null; //默认快捷缓存设置过期时间
  360. }
  361. if (is_null($tag)) {
  362. return $cache->set($name, $value, $expire);
  363. } else {
  364. return $cache->tag($tag)->set($name, $value, $expire);
  365. }
  366. }
  367. }
  368. }
  369. if (!function_exists('trace')) {
  370. /**
  371. * 记录日志信息
  372. * @param mixed $log log信息 支持字符串和数组
  373. * @param string $level 日志级别
  374. * @return void|array
  375. */
  376. function trace($log = '[think]', $level = 'log')
  377. {
  378. if ('[think]' === $log) {
  379. return Log::getLog();
  380. } else {
  381. Log::record($log, $level);
  382. }
  383. }
  384. }
  385. if (!function_exists('request')) {
  386. /**
  387. * 获取当前Request对象实例
  388. * @return Request
  389. */
  390. function request()
  391. {
  392. return Request::instance();
  393. }
  394. }
  395. if (!function_exists('response')) {
  396. /**
  397. * 创建普通 Response 对象实例
  398. * @param mixed $data 输出数据
  399. * @param int|string $code 状态码
  400. * @param array $header 头信息
  401. * @param string $type
  402. * @return Response
  403. */
  404. function response($data = [], $code = 200, $header = [], $type = 'html')
  405. {
  406. return Response::create($data, $type, $code, $header);
  407. }
  408. }
  409. if (!function_exists('view')) {
  410. /**
  411. * 渲染模板输出
  412. * @param string $template 模板文件
  413. * @param array $vars 模板变量
  414. * @param array $replace 模板替换
  415. * @param integer $code 状态码
  416. * @return \think\response\View
  417. */
  418. function view($template = '', $vars = [], $replace = [], $code = 200)
  419. {
  420. return Response::create($template, 'view', $code)->replace($replace)->assign($vars);
  421. }
  422. }
  423. if (!function_exists('json')) {
  424. /**
  425. * 获取\think\response\Json对象实例
  426. * @param mixed $data 返回的数据
  427. * @param integer $code 状态码
  428. * @param array $header 头部
  429. * @param array $options 参数
  430. * @return \think\response\Json
  431. */
  432. function json($data = [], $code = 200, $header = [], $options = [])
  433. {
  434. return Response::create($data, 'json', $code, $header, $options);
  435. }
  436. }
  437. if (!function_exists('jsonp')) {
  438. /**
  439. * 获取\think\response\Jsonp对象实例
  440. * @param mixed $data 返回的数据
  441. * @param integer $code 状态码
  442. * @param array $header 头部
  443. * @param array $options 参数
  444. * @return \think\response\Jsonp
  445. */
  446. function jsonp($data = [], $code = 200, $header = [], $options = [])
  447. {
  448. return Response::create($data, 'jsonp', $code, $header, $options);
  449. }
  450. }
  451. if (!function_exists('xml')) {
  452. /**
  453. * 获取\think\response\Xml对象实例
  454. * @param mixed $data 返回的数据
  455. * @param integer $code 状态码
  456. * @param array $header 头部
  457. * @param array $options 参数
  458. * @return \think\response\Xml
  459. */
  460. function xml($data = [], $code = 200, $header = [], $options = [])
  461. {
  462. return Response::create($data, 'xml', $code, $header, $options);
  463. }
  464. }
  465. if (!function_exists('redirect')) {
  466. /**
  467. * 获取\think\response\Redirect对象实例
  468. * @param mixed $url 重定向地址 支持Url::build方法的地址
  469. * @param array|integer $params 额外参数
  470. * @param integer $code 状态码
  471. * @param array $with 隐式传参
  472. * @return \think\response\Redirect
  473. */
  474. function redirect($url = [], $params = [], $code = 302, $with = [])
  475. {
  476. if (is_integer($params)) {
  477. $code = $params;
  478. $params = [];
  479. }
  480. return Response::create($url, 'redirect', $code)->params($params)->with($with);
  481. }
  482. }
  483. if (!function_exists('abort')) {
  484. /**
  485. * 抛出HTTP异常
  486. * @param integer|Response $code 状态码 或者 Response对象实例
  487. * @param string $message 错误信息
  488. * @param array $header 参数
  489. */
  490. function abort($code, $message = null, $header = [])
  491. {
  492. if ($code instanceof Response) {
  493. throw new HttpResponseException($code);
  494. } else {
  495. throw new HttpException($code, $message, null, $header);
  496. }
  497. }
  498. }
  499. if (!function_exists('halt')) {
  500. /**
  501. * 调试变量并且中断输出
  502. * @param mixed $var 调试变量或者信息
  503. */
  504. function halt($var)
  505. {
  506. dump($var);
  507. throw new HttpResponseException(new Response);
  508. }
  509. }
  510. if (!function_exists('token')) {
  511. /**
  512. * 生成表单令牌
  513. * @param string $name 令牌名称
  514. * @param mixed $type 令牌生成方法
  515. * @return string
  516. */
  517. function token($name = '__token__', $type = 'md5')
  518. {
  519. $token = Request::instance()->token($name, $type);
  520. return '<input type="hidden" name="' . $name . '" value="' . $token . '" />';
  521. }
  522. }
  523. if (!function_exists('load_relation')) {
  524. /**
  525. * 延迟预载入关联查询
  526. * @param mixed $resultSet 数据集
  527. * @param mixed $relation 关联
  528. * @return array
  529. */
  530. function load_relation($resultSet, $relation)
  531. {
  532. $item = current($resultSet);
  533. if ($item instanceof Model) {
  534. $item->eagerlyResultSet($resultSet, $relation);
  535. }
  536. return $resultSet;
  537. }
  538. }
  539. if (!function_exists('collection')) {
  540. /**
  541. * 数组转换为数据集对象
  542. * @param array $resultSet 数据集数组
  543. * @return \think\model\Collection|\think\Collection
  544. */
  545. function collection($resultSet)
  546. {
  547. $item = current($resultSet);
  548. if ($item instanceof Model) {
  549. return \think\model\Collection::make($resultSet);
  550. } else {
  551. return \think\Collection::make($resultSet);
  552. }
  553. }
  554. }