ThinkPHP6的助手函数汇总

abort(): 抛出HTTP异常

/**

  • 抛出HTTP异常
  • @param integer|Response $code 状态码 或者 Response对象实例
  • @param string $message 错误信息
  • @param array $header 参数
    */
    abort($code, string $message = ”, array $header = [])

app(): 快速获取容器中的实例 支持依赖注入

/**

  • 快速获取容器中的实例 支持依赖注入
  • @param string $name 类名或标识 默认获取当前应用实例
  • @param array $args 参数
  • @param bool $newInstance 是否每次创建新的实例
  • @return object|App
    */
    app(string $name = ”, array $args = [], bool $newInstance = false)

bind(): 绑定一个类到容器

/**

  • 绑定一个类到容器
  • @param string|array $abstract 类标识、接口(支持批量绑定)
  • @param mixed $concrete 要绑定的类、闭包或者实例
  • @return Container
    */
    bind($abstract, $concrete = null)

cache(): 缓存管理

/**

  • 缓存管理
  • @param string $name 缓存名称
  • @param mixed $value 缓存值
  • @param mixed $options 缓存参数
  • @param string $tag 缓存标签
  • @return mixed
    */
    cache(string $name = null, $value = ”, $options = null, $tag = null)

config(): 获取和设置配置参数

/**

  • 获取和设置配置参数
  • @param string|array $name 参数名
  • @param mixed $value 参数值
  • @return mixed
    */
    config($name = ”, $value = null)

env(): 获取环境变量值

/**

  • 获取环境变量值
  • @access public
  • @param string $name 环境变量名(支持二级 .号分割)
  • @param string $default 默认值
  • @return mixed
    */
    env(string $name = null, $default = null)

cookie(): Cookie管理

/**

  • Cookie管理
  • @param string $name cookie名称
  • @param mixed $value cookie值
  • @param mixed $option 参数
  • @return mixed
    */
    cookie(string $name, $value = ”, $option = null)

session(): Session管理

/**

  • Session管理
  • @param string $name session名称
  • @param mixed $value session值
  • @return mixed
    */
    session($name = ”, $value = ”)

download(): 获取\think\response\Download对象实例

/**

  • 获取\think\response\Download对象实例
  • @param string $filename 要下载的文件
  • @param string $name 显示文件名
  • @param bool $content 是否为内容
  • @param int $expire 有效期(秒)
  • @return \think\response\File
    */
    download(string $filename, string $name = ”, bool $content = false, int $expire = 180)

dump(): 浏览器友好的变量输出

/**

  • 浏览器友好的变量输出
  • @param mixed $vars 要输出的变量
  • @return void
    */
    dump(…$vars)

halt(): 调试变量并且中断输出

/**

  • 调试变量并且中断输出
  • @param mixed $vars 调试变量或者信息
    */
    halt(…$vars)

event(): 触发事件

/**

  • 触发事件
  • @param mixed $event 事件名(或者类名)
  • @param mixed $args 参数
  • @return mixed
    */
    event($event, $args = null)

input(): 获取输入数据 支持默认值和过滤

/**

  • 获取输入数据 支持默认值和过滤
  • @param string $key 获取的变量名
  • @param mixed $default 默认值
  • @param string $filter 过滤方法
  • @return mixed
    */
    input(string $key = ”, $default = null, $filter = ”)

invoke(): 调用反射实例化对象或者执行方法 支持依赖注入

/**

  • 调用反射实例化对象或者执行方法 支持依赖注入
  • @param mixed $call 类名或者callable
  • @param array $args 参数
  • @return mixed
    */
    invoke($call, array $args = [])

json(): 获取\think\response\Json对象实例

/**

  • 获取\think\response\Json对象实例
  • @param mixed $data 返回的数据
  • @param int $code 状态码
  • @param array $header 头部
  • @param array $options 参数
  • @return \think\response\Json
    */
    json($data = [], $code = 200, $header = [], $options = [])

jsonp(): 获取\think\response\Jsonp对象实例

/**

  • 获取\think\response\Jsonp对象实例
  • @param mixed $data 返回的数据
  • @param int $code 状态码
  • @param array $header 头部
  • @param array $options 参数
  • @return \think\response\Jsonp
    */
    jsonp($data = [], $code = 200, $header = [], $options = [])

lang(): 获取语言变量值

/**

  • 获取语言变量值
  • @param string $name 语言变量名
  • @param array $vars 动态变量值
  • @param string $lang 语言
  • @return mixed
    */
    lang(string $name, array $vars = [], string $lang = ”)

parse_name(): 字符串命名风格转换

/**

  • 字符串命名风格转换
  • type 0 将Java风格转换为C的风格 1 将C风格转换为Java的风格
  • @param string $name 字符串
  • @param int $type 转换类型
  • @param bool $ucfirst 首字母是否大写(驼峰规则)
  • @return string
    */
    parse_name(string $name, int $type = 0, bool $ucfirst = true)

redirect(): 获取\think\response\Redirect对象实例

/**

  • 获取\think\response\Redirect对象实例
  • @param string $url 重定向地址
  • @param int $code 状态码
  • @return \think\response\Redirect
    */
    redirect(string $url = ”, int $code = 302)

request(): 获取当前Request对象实例

/**

  • 获取当前Request对象实例
  • @return Request
    */
    request()

response(): 创建普通 Response 对象实例

/**

  • 创建普通 Response 对象实例
  • @param mixed $data 输出数据
  • @param int|string $code 状态码
  • @param array $header 头信息
  • @param string $type
  • @return Response
    */
    response($data = ”, $code = 200, $header = [], $type = ‘html’)

token(): 获取Token令牌

/**

  • 获取Token令牌
  • @param string $name 令牌名称
  • @param mixed $type 令牌生成方法
  • @return string
    */
    token(string $name = ‘token‘, string $type = ‘md5’)

token_field(): 生成令牌隐藏表单

/**

  • 生成令牌隐藏表单
  • @param string $name 令牌名称
  • @param mixed $type 令牌生成方法
  • @return string
    */
    token_field(string $name = ‘token‘, string $type = ‘md5’)

token_meta(): 生成令牌meta

/**

  • 生成令牌meta
  • @param string $name 令牌名称
  • @param mixed $type 令牌生成方法
  • @return string
    */
    token_meta(string $name = ‘token‘, string $type = ‘md5’)

trace(): 记录日志信息

/**

  • 记录日志信息
  • @param mixed $log log信息 支持字符串和数组
  • @param string $level 日志级别
  • @return array|void
    */
    trace($log = ‘[think]’, string $level = ‘log’)

url(): Url生成

/**

  • Url生成
  • @param string $url 路由地址
  • @param array $vars 变量
  • @param bool|string $suffix 生成的URL后缀
  • @param bool|string $domain 域名
  • @return UrlBuild
    */
    url(string $url = ”, array $vars = [], $suffix = true, $domain = false)

validate(): 生成验证对象

/**

  • 生成验证对象
  • @param string|array $validate 验证器类名或者验证规则数组
  • @param array $message 错误提示信息
  • @param bool $batch 是否批量验证
  • @param bool $failException 是否抛出异常
  • @return Validate
    */
    validate($validate = ”, array $message = [], bool $batch = false, bool $failException = true)

view(): 渲染模板输出

/**

  • 渲染模板输出
  • @param string $template 模板文件
  • @param array $vars 模板变量
  • @param int $code 状态码
  • @param callable $filter 内容过滤
  • @return \think\response\View
    */
    view(string $template = ”, $vars = [], $code = 200, $filter = null)

display(): 渲染模板输出

/**

  • 渲染模板输出
  • @param string $content 渲染内容
  • @param array $vars 模板变量
  • @param int $code 状态码
  • @param callable $filter 内容过滤
  • @return \think\response\View
    */
    display(string $content, $vars = [], $code = 200, $filter = null)

xml(): 获取\think\response\xml对象实例

/**

  • 获取\think\response\Xml对象实例
  • @param mixed $data 返回的数据
  • @param int $code 状态码
  • @param array $header 头部
  • @param array $options 参数
  • @return \think\response\Xml
    */
    xml($data = [], $code = 200, $header = [], $options = [])

app_path(): 获取当前应用目录

/**

  • 获取当前应用目录
    *
  • @param string $path
  • @return string
    */
    app_path($path = ”)

base_path(): 获取应用基础目录

/**

  • 获取应用基础目录
    *
  • @param string $path
  • @return string
    */
    base_path($path = ”)

config_path(): 获取应用配置目录

/**

  • 获取应用配置目录
    *
  • @param string $path
  • @return string
    */
    config_path($path = ”)

public_path(): 获取web根目录

/**

  • 获取web根目录
    *
  • @param string $path
  • @return string
    */
    public_path($path = ”)

runtime_path(): 获取应用运行时目录

/**

  • 获取应用运行时目录
    *
  • @param string $path
  • @return string
    */
    runtime_path($path = ”)

root_path(): 获取项目根目录

/**

  • 获取项目根目录
    *
  • @param string $path
  • @return string
    */
    root_path($path = ”)

最后:尽量少的使用助手函数,项目中助手函数过多容易造成运行效率慢;