助手函数汇总 · 梧桐树tp6备忘录

**abort(): 抛出HTTP异常** 1. /\*\* 2. \* 抛出HTTP异常 3. \* @param integer|Response $code 状态码或者 Response对象实例 4. \* @param string $message 错误信息 5. \* @param array $header 参数 6. \*/ 7. abort($code, string $message \= '', array $header \= \[\]) **app(): 快速获取容器中的实例支持依赖注入** 1. /\*\* 2. \* 快速获取容器中的实例支持依赖注入 3. \* @param string $name 类名或标识默认获取当前应用实例 4. \* @param array $args 参数 5. \* @param bool $newInstance 是否每次创建新的实例 6. \* @return object|App 7. \*/ 8. app(string $name \= '', array $args \= \[\], bool $newInstance \= false) **bind(): 绑定一个类到容器** 1. /\*\* 2. \* 绑定一个类到容器 3. \* @param string|array $abstract 类标识、接口（支持批量绑定） 4. \* @param mixed $concrete 要绑定的类、闭包或者实例 5. \* @return Container 6. \*/ 7. bind($abstract, $concrete \= null) **cache(): 缓存管理** 1. /\*\* 2. \* 缓存管理 3. \* @param string $name 缓存名称 4. \* @param mixed $value 缓存值 5. \* @param mixed $options 缓存参数 6. \* @param string $tag 缓存标签 7. \* @return mixed 8. \*/ 9. cache(string $name \= null, $value \= '', $options \= null, $tag \= null) **config(): 获取和设置配置参数** 1. /\*\* 2. \* 获取和设置配置参数 3. \* @param string|array $name 参数名 4. \* @param mixed $value 参数值 5. \* @return mixed 6. \*/ 7. config($name \= '', $value \= null) **env(): 获取环境变量值** 1. /\*\* 2. \* 获取环境变量值 3. \* @access public 4. \* @param string $name 环境变量名（支持二级 .号分割） 5. \* @param string $default 默认值 6. \* @return mixed 7. \*/ 8. env(string $name \= null, $default \= null) **cookie(): Cookie管理** 1. /\*\* 2. \* Cookie管理 3. \* @param string $name cookie名称 4. \* @param mixed $value cookie值 5. \* @param mixed $option 参数 6. \* @return mixed 7. \*/ 8. cookie(string $name, $value \= '', $option \= null) **session(): Session管理** 1. /\*\* 2. \* Session管理 3. \* @param string $name session名称 4. \* @param mixed $value session值 5. \* @return mixed 6. \*/ 7. session($name \= '', $value \= '') **download(): 获取\\think\\response\\Download对象实例** 1. /\*\* 2. \* 获取\\think\\response\\Download对象实例 3. \* @param string $filename 要下载的文件 4. \* @param string $name 显示文件名 5. \* @param bool $content 是否为内容 6. \* @param int $expire 有效期（秒） 7. \* @return \\think\\response\\File 8. \*/ 9. download(string $filename, string $name \= '', bool $content \= false, int $expire \= 180) **dump(): 浏览器友好的变量输出** 1. /\*\* 2. \* 浏览器友好的变量输出 3. \* @param mixed $vars 要输出的变量 4. \* @return void 5. \*/ 6. dump(...$vars) **halt(): 调试变量并且中断输出** 1. /\*\* 2. \* 调试变量并且中断输出 3. \* @param mixed $vars 调试变量或者信息 4. \*/ 5. halt(...$vars) **event(): 触发事件** 1. /\*\* 2. \* 触发事件 3. \* @param mixed $event 事件名（或者类名） 4. \* @param mixed $args 参数 5. \* @return mixed 6. \*/ 7. event($event, $args \= null) **input(): 获取输入数据支持默认值和过滤** 1. /\*\* 2. \* 获取输入数据支持默认值和过滤 3. \* @param string $key 获取的变量名 4. \* @param mixed $default 默认值 5. \* @param string $filter 过滤方法 6. \* @return mixed 7. \*/ 8. input(string $key \= '', $default \= null, $filter \= '') **invoke(): 调用反射实例化对象或者执行方法支持依赖注入** 1. /\*\* 2. \* 调用反射实例化对象或者执行方法支持依赖注入 3. \* @param mixed $call 类名或者callable 4. \* @param array $args 参数 5. \* @return mixed 6. \*/ 7. invoke($call, array $args \= \[\]) **json(): 获取\\think\\response\\Json对象实例** 1. /\*\* 2. \* 获取\\think\\response\\Json对象实例 3. \* @param mixed $data 返回的数据 4. \* @param int $code 状态码 5. \* @param array $header 头部 6. \* @param array $options 参数 7. \* @return \\think\\response\\Json 8. \*/ 9. json($data \= \[\], $code \= 200, $header \= \[\], $options \= \[\]) **jsonp(): 获取\\think\\response\\Jsonp对象实例** 1. /\*\* 2. \* 获取\\think\\response\\Jsonp对象实例 3. \* @param mixed $data 返回的数据 4. \* @param int $code 状态码 5. \* @param array $header 头部 6. \* @param array $options 参数 7. \* @return \\think\\response\\Jsonp 8. \*/ 9. jsonp($data \= \[\], $code \= 200, $header \= \[\], $options \= \[\]) **lang(): 获取语言变量值** 1. /\*\* 2. \* 获取语言变量值 3. \* @param string $name 语言变量名 4. \* @param array $vars 动态变量值 5. \* @param string $lang 语言 6. \* @return mixed 7. \*/ 8. lang(string $name, array $vars \= \[\], string $lang \= '') **parse\_name(): 字符串命名风格转换** 1. /\*\* 2. \* 字符串命名风格转换 3. \* type 0 将Java风格转换为C的风格 1 将C风格转换为Java的风格 4. \* @param string $name 字符串 5. \* @param int $type 转换类型 6. \* @param bool $ucfirst 首字母是否大写（驼峰规则） 7. \* @return string 8. \*/ 9. parse\_name(string $name, int $type \= 0, bool $ucfirst \= true) **redirect(): 获取\\think\\response\\Redirect对象实例** 1. /\*\* 2. \* 获取\\think\\response\\Redirect对象实例 3. \* @param string $url 重定向地址 4. \* @param int $code 状态码 5. \* @return \\think\\response\\Redirect 6. \*/ 7. redirect(string $url \= '', int $code \= 302) **request(): 获取当前Request对象实例** 1. /\*\* 2. \* 获取当前Request对象实例 3. \* @return Request 4. \*/ 5. request() **response(): 创建普通 Response 对象实例** 1. /\*\* 2. \* 创建普通 Response 对象实例 3. \* @param mixed $data 输出数据 4. \* @param int|string $code 状态码 5. \* @param array $header 头信息 6. \* @param string $type 7. \* @return Response 8. \*/ 9. response($data \= '', $code \= 200, $header \= \[\], $type \= 'html') **token(): 获取Token令牌** 1. /\*\* 2. \* 获取Token令牌 3. \* @param string $name 令牌名称 4. \* @param mixed $type 令牌生成方法 5. \* @return string 6. \*/ 7. token(string $name \= '\_\_token\_\_', string $type \= 'md5') **token\_field(): 生成令牌隐藏表单** 1. /\*\* 2. \* 生成令牌隐藏表单 3. \* @param string $name 令牌名称 4. \* @param mixed $type 令牌生成方法 5. \* @return string 6. \*/ 7. token\_field(string $name \= '\_\_token\_\_', string $type \= 'md5') **token\_meta(): 生成令牌meta** 1. /\*\* 2. \* 生成令牌meta 3. \* @param string $name 令牌名称 4. \* @param mixed $type 令牌生成方法 5. \* @return string 6. \*/ 7. token\_meta(string $name \= '\_\_token\_\_', string $type \= 'md5') **trace(): 记录日志信息** 1. /\*\* 2. \* 记录日志信息 3. \* @param mixed $log log信息支持字符串和数组 4. \* @param string $level 日志级别 5. \* @return array|void 6. \*/ 7. trace($log \= '\[think\]', string $level \= 'log') **url(): Url生成** 1. /\*\* 2. \* Url生成 3. \* @param string $url 路由地址 4. \* @param array $vars 变量 5. \* @param bool|string $suffix 生成的URL后缀 6. \* @param bool|string $domain 域名 7. \* @return UrlBuild 8. \*/ 9. url(string $url \= '', array $vars \= \[\], $suffix \= true, $domain \= false) **validate(): 生成验证对象** 1. /\*\* 2. \* 生成验证对象 3. \* @param string|array $validate 验证器类名或者验证规则数组 4. \* @param array $message 错误提示信息 5. \* @param bool $batch 是否批量验证 6. \* @param bool $failException 是否抛出异常 7. \* @return Validate 8. \*/ 9. validate($validate \= '', array $message \= \[\], bool $batch \= false, bool $failException \= true) **view(): 渲染模板输出** 1. /\*\* 2. \* 渲染模板输出 3. \* @param string $template 模板文件 4. \* @param array $vars 模板变量 5. \* @param int $code 状态码 6. \* @param callable $filter 内容过滤 7. \* @return \\think\\response\\View 8. \*/ 9. view(string $template \= '', $vars \= \[\], $code \= 200, $filter \= null) **display(): 渲染模板输出** 1. /\*\* 2. \* 渲染模板输出 3. \* @param string $content 渲染内容 4. \* @param array $vars 模板变量 5. \* @param int $code 状态码 6. \* @param callable $filter 内容过滤 7. \* @return \\think\\response\\View 8. \*/ 9. display(string $content, $vars \= \[\], $code \= 200, $filter \= null) **xml(): 获取\\think\\response\\xml对象实例** 1. /\*\* 2. \* 获取\\think\\response\\Xml对象实例 3. \* @param mixed $data 返回的数据 4. \* @param int $code 状态码 5. \* @param array $header 头部 6. \* @param array $options 参数 7. \* @return \\think\\response\\Xml 8. \*/ 9. xml($data \= \[\], $code \= 200, $header \= \[\], $options \= \[\]) **app\_path(): 获取当前应用目录** 1. /\*\* 2. \* 获取当前应用目录 3. \* 4. \* @param string $path 5. \* @return string 6. \*/ 7. app\_path($path \= '') **base\_path(): 获取应用基础目录** 1. /\*\* 2. \* 获取应用基础目录 3. \* 4. \* @param string $path 5. \* @return string 6. \*/ 7. base\_path($path \= '') **config\_path(): 获取应用配置目录** 1. /\*\* 2. \* 获取应用配置目录 3. \* 4. \* @param string $path 5. \* @return string 6. \*/ 7. config\_path($path \= '') **public\_path(): 获取web根目录** 1. /\*\* 2. \* 获取web根目录 3. \* 4. \* @param string $path 5. \* @return string 6. \*/ 7. public\_path($path \= '') **runtime\_path(): 获取应用运行时目录** 1. /\*\* 2. \* 获取应用运行时目录 3. \* 4. \* @param string $path 5. \* @return string 6. \*/ 7. runtime\_path($path \= '') **root\_path(): 获取项目根目录** 1. /\*\* 2. \* 获取项目根目录 3. \* 4. \* @param string $path 5. \* @return string 6. \*/ 7. root\_path($path \= '') 最后：尽量少的使用助手函数，项目中助手函数过多容易造成运行效率慢；