thinkphphelper.php

Functions

abort()

abort(integer|\think\Response  $code, string  $message = null, array  $header = array()) 

抛出HTTP异常

Parameters

integer|\think\Response $code

状态码 或者 Response对象实例

string $message

错误信息

array $header

参数

action()

action(string  $url, string|array  $vars = array(), string  $layer = 'controller', boolean  $appendSuffix = false) : mixed

调用模块的操作方法 参数格式 [模块/控制器/]操作

Parameters

string $url

调用地址

string|array $vars

调用参数 支持字符串和数组

string $layer

要调用的控制层名称

boolean $appendSuffix

是否添加类名后缀

Returns

mixed

app()

app(string  $name = 'think\App', array  $args = array(), boolean  $newInstance = false) : mixed|\think\App

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

Parameters

string $name

类名或标识 默认获取当前应用实例

array $args

参数

boolean $newInstance

是否每次创建新的实例

Returns

mixed|\think\App

behavior()

behavior(mixed  $behavior, mixed  $args = null) : mixed

执行某个行为(run方法) 支持依赖注入

Parameters

mixed $behavior

行为类名或者别名

mixed $args

参数

Returns

mixed

bind()

bind(string  $abstract, mixed  $concrete = null) : \think\Container

绑定一个类到容器

Parameters

string $abstract

类标识、接口

mixed $concrete

要绑定的类、闭包或者实例

Returns

\think\Container

cache()

cache(mixed  $name, mixed  $value = '', mixed  $options = null, string  $tag = null) : mixed

缓存管理

Parameters

mixed $name

缓存名称,如果为数组表示进行缓存设置

mixed $value

缓存值

mixed $options

缓存参数

string $tag

缓存标签

Returns

mixed

call()

call(mixed  $callable, array  $args = array()) : mixed

调用反射执行callable 支持依赖注入

Parameters

mixed $callable

支持闭包等callable写法

array $args

参数

Returns

mixed

class_basename()

class_basename(string|object  $class) : string

获取类名(不包含命名空间)

Parameters

string|object $class

Returns

string

class_uses_recursive()

class_uses_recursive(  $class) : array

获取一个类里所有用到的trait,包括父类的

Parameters

$class

Returns

array

config()

config(string|array  $name = '', mixed  $value = null) : mixed

获取和设置配置参数

Parameters

string|array $name

参数名

mixed $value

参数值

Returns

mixed

container()

container() : \think\Container

获取容器对象实例

Returns

\think\Container

controller()

controller(string  $name, string  $layer = 'controller', boolean  $appendSuffix = false) : \think\Controller

实例化控制器 格式:[模块/]控制器

Parameters

string $name

资源地址

string $layer

控制层名称

boolean $appendSuffix

是否添加类名后缀

Returns

\think\Controller

cookie()

cookie(string|array  $name, mixed  $value = '', mixed  $option = null) : mixed

Cookie管理

Parameters

string|array $name

cookie名称,如果为数组表示进行cookie设置

mixed $value

cookie值

mixed $option

参数

Returns

mixed

db()

db(string  $name = '', array|string  $config = array(), boolean  $force = true) : \think\db\Query

实例化数据库类

Parameters

string $name

操作的数据表名称(不含前缀)

array|string $config

数据库配置参数

boolean $force

是否强制重新连接

Returns

\think\db\Query

debug()

debug(string  $start, string  $end = '', integer|string  $dec = 6) : mixed

记录时间(微秒)和内存使用情况

Parameters

string $start

开始标签

string $end

结束标签

integer|string $dec

小数位 如果是m 表示统计内存占用

Returns

mixed

download()

download(string  $filename, string  $name = '', boolean  $content = false, integer  $expire = 360,   $openinBrower = false) : \think\response\Download

获取\think\response\Download对象实例

Parameters

string $filename

要下载的文件

string $name

显示文件名

boolean $content

是否为内容

integer $expire

有效期(秒)

$openinBrower

Returns

\think\response\Download

dump()

dump(mixed  $var, boolean  $echo = true, string  $label = null) : void|string

浏览器友好的变量输出

Parameters

mixed $var

变量

boolean $echo

是否输出 默认为true 如果为false 则返回输出字符串

string $label

标签 默认为空

Returns

void|string

env()

env(string  $name = null, string  $default = null) : mixed

获取环境变量值

Parameters

string $name

环境变量名(支持二级 .号分割)

string $default

默认值

Returns

mixed

exception()

exception(string  $msg, integer  $code, string  $exception = '') 

抛出异常处理

Parameters

string $msg

异常消息

integer $code

异常代码 默认为0

string $exception

异常类

Throws

\Exception

halt()

halt(mixed  $var) 

调试变量并且中断输出

Parameters

mixed $var

调试变量或者信息

input()

input(string  $key = '', mixed  $default = null, string  $filter = '') : mixed

获取输入数据 支持默认值和过滤

Parameters

string $key

获取的变量名

mixed $default

默认值

string $filter

过滤方法

Returns

mixed

json()

json(mixed  $data = array(), integer  $code = 200, array  $header = array(), array  $options = array()) : \think\response\Json

获取\think\response\Json对象实例

Parameters

mixed $data

返回的数据

integer $code

状态码

array $header

头部

array $options

参数

Returns

\think\response\Json

jsonp()

jsonp(mixed  $data = array(), integer  $code = 200, array  $header = array(), array  $options = array()) : \think\response\Jsonp

获取\think\response\Jsonp对象实例

Parameters

mixed $data

返回的数据

integer $code

状态码

array $header

头部

array $options

参数

Returns

\think\response\Jsonp

lang()

lang(string  $name, array  $vars = array(), string  $lang = '') : mixed

获取语言变量值

Parameters

string $name

语言变量名

array $vars

动态变量值

string $lang

语言

Returns

mixed

model()

model(string  $name = '', string  $layer = 'model', boolean  $appendSuffix = false) : \think\Model

实例化Model

Parameters

string $name

Model名称

string $layer

业务层名称

boolean $appendSuffix

是否添加类名后缀

Returns

\think\Model

parse_name()

parse_name(string  $name, integer  $type, boolean  $ucfirst = true) : string

字符串命名风格转换 type 0 将Java风格转换为C的风格 1 将C风格转换为Java的风格

Parameters

string $name

字符串

integer $type

转换类型

boolean $ucfirst

首字母是否大写(驼峰规则)

Returns

string

redirect()

redirect(mixed  $url = array(), array|integer  $params = array(), integer  $code = 302) : \think\response\Redirect

获取\think\response\Redirect对象实例

Parameters

mixed $url

重定向地址 支持Url::build方法的地址

array|integer $params

额外参数

integer $code

状态码

Returns

\think\response\Redirect

request()

request() : \think\facade\Request

获取当前Request对象实例

Returns

\think\facade\Request

response()

response(mixed  $data = array(), integer|string  $code = 200, array  $header = array(), string  $type = 'html') : \think\Response

创建普通 Response 对象实例

Parameters

mixed $data

输出数据

integer|string $code

状态码

array $header

头信息

string $type

Returns

\think\Response

route()

route(string  $rule, mixed  $route, array  $option = array(), array  $pattern = array()) : \think\route\RuleItem

路由注册

Parameters

string $rule

路由规则

mixed $route

路由地址

array $option

路由参数

array $pattern

变量规则

Returns

\think\route\RuleItem

session()

session(string|array  $name, mixed  $value = '', string  $prefix = null) : mixed

Session管理

Parameters

string|array $name

session名称,如果为数组表示进行session设置

mixed $value

session值

string $prefix

前缀

Returns

mixed

token()

token(string  $name = '__token__', mixed  $type = 'md5') : string

生成表单令牌

Parameters

string $name

令牌名称

mixed $type

令牌生成方法

Returns

string

trace()

trace(mixed  $log = '[think]', string  $level = 'log') : array|void

记录日志信息

Parameters

mixed $log

log信息 支持字符串和数组

string $level

日志级别

Returns

array|void

trait_uses_recursive()

trait_uses_recursive(string  $trait) : array

获取一个trait里所有引用到的trait

Parameters

string $trait

Returns

array

url()

url(string  $url = '', string|array  $vars = '', boolean|string  $suffix = true, boolean|string  $domain = false) : string

Url生成

Parameters

string $url

路由地址

string|array $vars

变量

boolean|string $suffix

生成的URL后缀

boolean|string $domain

域名

Returns

string

validate()

validate(string  $name = '', string  $layer = 'validate', boolean  $appendSuffix = false) : \think\Validate

实例化验证器

Parameters

string $name

验证器名称

string $layer

业务层名称

boolean $appendSuffix

是否添加类名后缀

Returns

\think\Validate

view()

view(string  $template = '', array  $vars = array(), integer  $code = 200, callable  $filter = null) : \think\response\View

渲染模板输出

Parameters

string $template

模板文件

array $vars

模板变量

integer $code

状态码

callable $filter

内容过滤

Returns

\think\response\View

widget()

widget(string  $name, array  $data = array()) : mixed

渲染输出Widget

Parameters

string $name

Widget名称

array $data

传入的参数

Returns

mixed

xml()

xml(mixed  $data = array(), integer  $code = 200, array  $header = array(), array  $options = array()) : \think\response\Xml

获取\think\response\Xml对象实例

Parameters

mixed $data

返回的数据

integer $code

状态码

array $header

头部

array $options

参数

Returns

\think\response\Xml

yaconf()

yaconf(string  $name, mixed  $default = null) : mixed

获取yaconf配置

Parameters

string $name

配置参数名

mixed $default

默认值

Returns

mixed