Constants

__ROOT__

__ROOT__ = $this->request->rootUrl()

__ROOT__

__ROOT__ = request()->rootUrl()

__ROOT__

__ROOT__ = $this->request->rootUrl()

ADDON_PATH

ADDON_PATH = \think\facade\Env::get('root_path') . 'addons' . DIRECTORY_SEPARATOR

APP_PATH

APP_PATH = __DIR__ . '/app/'

EFFECTED_INIT

EFFECTED_INIT = 1

IOURL

IOURL = dirname(dirname(__FILE__))

QINIU_FUNCTIONS_VERSION

QINIU_FUNCTIONS_VERSION = \Qiniu\Config::SDK_VER

ROOT

ROOT = dirname(dirname(IOURL)) . DIRECTORY_SEPARATOR

ShearURL

ShearURL = ROOT . 'data' . DIRECTORY_SEPARATOR . 'upload' . DIRECTORY_SEPARATOR . 'avatar' . DIRECTORY_SEPARATOR

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

addon_url()

addon_url(  $url, array  $param = array(), boolean|string  $suffix = true, boolean|string  $domain = false) : boolean|string

插件显示内容里生成访问插件的url

Parameters

$url
array $param
boolean|string $suffix

生成的URL后缀

boolean|string $domain

域名

Returns

boolean|string

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

captcha()

captcha(string  $id = '', array  $config = array()) : \think\Response

Parameters

string $id
array $config

Returns

\think\Response

captcha_check()

captcha_check(  $value, string  $id = '') : boolean

Parameters

$value
string $id

Returns

boolean

captcha_img()

captcha_img(  $id = '') : mixed

Parameters

$id

Returns

mixed

captcha_src()

captcha_src(  $id = '') : string

Parameters

$id

Returns

string

category_text()

category_text(string  $lang = 'zh-cn', boolean  $all = false) : array|mixed

返回分类层级text数组

Parameters

string $lang
boolean $all

Throws

Returns

array|mixed

class_basename()

class_basename(string|object  $class) : string

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

Parameters

string|object $class

Returns

string

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

class_uses_recursive()

class_uses_recursive(  $class) : array

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

Parameters

$class

Returns

array

classLoader()

classLoader(  $class) 

Parameters

$class

classnames()

classnames() 

css样式名生成器 classnames("foo", "bar"); // => "foo bar" classnames("foo", [ "bar"=> true ]); // => "foo bar" classnames([ "foo-bar"=> true ]); // => "foo-bar" classnames([ "foo-bar"=> false ]); // => " classnames([ "foo" => true ], [ "bar"=> true ]); // => "foo bar" classnames([ "foo" => true, "bar"=> true ]); // => "foo bar" classnames("foo", [ "bar"=> true, "duck"=> false ], "baz", [ "quux"=> true ]); // => "foo bar baz quux" classnames(null, false, "bar", 0, 1, [ "baz"=> null ]); // => "bar 1"

composerRequire4d887799dd503f5d23b8e41833560d31()

composerRequire4d887799dd503f5d23b8e41833560d31(  $fileIdentifier,   $file) 

Parameters

$fileIdentifier
$file

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

copydirs()

copydirs(string  $source, string  $dest) 

复制文件夹

Parameters

string $source

源文件夹

string $dest

目标文件夹

create_admin_account()

create_admin_account(\think\db\  $db, string  $table_prefix) 

创建管理员

Parameters

\think\db\ $db
string $table_prefix

create_config()

create_config(array  $config) : mixed

写入配置

Parameters

array $config

Returns

mixed

create_dir()

create_dir(string  $path) : boolean

建立文件夹

Parameters

string $path

Returns

boolean

data_signature()

data_signature(array  $data = array()) : string

数据签名

Parameters

array $data

被认证的数据

Returns

string —

签名

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

db_get_db_prefix_holder()

db_get_db_prefix_holder() : string

返回表前缀替代符

Returns

string

db_get_insert_sqls()

db_get_insert_sqls(  $table) : string

返回数据表的sql

Parameters

$table

: 不含前缀的表名

Returns

string

db_get_tables()

db_get_tables(  $prefix = false) : array

返回不含前缀的数据库表数组

Parameters

$prefix

Returns

array

db_is_valid_table_name()

db_is_valid_table_name(  $table) : boolean

检测当前数据库中是否含指定表

Parameters

$table

: 不含前缀的数据表名

Returns

boolean

db_restore_file()

db_restore_file(  $file,   $prefix = '') 

不检测表前缀,恢复数据库

Parameters

$file
$prefix

debug()

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

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

Parameters

string $start

开始标签

string $end

结束标签

integer|string $dec

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

Returns

mixed

dir_path()

dir_path(string  $path) : string

返回路径

Parameters

string $path

Returns

string

dump()

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

浏览器友好的变量输出

Parameters

mixed $var

变量

boolean $echo

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

string $label

标签 默认为空

Returns

void|string

encrypt_password()

encrypt_password(string  $password, string  $password_salt) : string

所有用到密码的不可逆加密方式

Parameters

string $password
string $password_salt

Returns

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

execute_sql()

execute_sql(\think\db\  $db, string  $file, string  $tablepre) : mixed

执行sql文件

Parameters

\think\db\ $db
string $file
string $tablepre

Returns

mixed

force_download_content()

force_download_content(string  $filename, string  $content) 

强制下载

Parameters

string $filename
string $content

format_bytes()

format_bytes(\number  $size, string  $delimiter = '') : string

格式化字节大小

Parameters

\number $size

字节数

string $delimiter

数字和单位分隔符

Returns

string —

格式化后的带单位的大小

format_tobytes()

format_tobytes(string  $size, integer  $dec) : integer

转换成字节数

Parameters

string $size

大小如10M 100G 1.2T

integer $dec

小数位数

Returns

integer —

格式化后字节数

get_addon_class()

get_addon_class(string  $name, string  $type = 'hook', string  $class = null) : string

获取插件类的类名

Parameters

string $name

插件名

string $type

返回命名空间类型

string $class

当前类名

Returns

string

get_category_byid()

get_category_byid(integer  $id, boolean  $self = false, integer  $status, string  $field = 'id', boolean  $lang = false) : array|mixed

获取文章分类ids

Parameters

integer $id

待获取的id

boolean $self

是否返回自身,默认false

integer $status

1表示只显示status=1的,0表示只显示status=0的,2表示不限制

string $field

默认只返回id数组(一维),其它如:"*"表示全部字段,"id,menu_name"表示返回二维数组

boolean $lang

是否只返回当前语言下分类,默认false

Throws

\think\Exception

Returns

array|mixed

get_host()

get_host() 

返回带协议的域名

get_imgurl()

get_imgurl(string  $url, integer  $cat) : string

获取图片完整路径

Parameters

string $url

待获取图片url

integer $cat

待获取图片类别 0为文章 1前台头像 2后台头像

Returns

string —

完整图片imgurl

get_query()

get_query() : array

获取当前request参数数组,去除值为空

Returns

array

get_themes()

get_themes(string  $module = 'cms') : array|mixed

获取模块主题

Parameters

string $module

Returns

array|mixed

get_tpls()

get_tpls(string  $module = 'cms') : array|mixed

取模块模板列表

Parameters

string $module

Returns

array|mixed

getBroswer()

getBroswer() : string

获取客户端浏览器信息 添加win10 edge浏览器判断

Returns

string

getOs()

getOs() : string

获取客户端操作系统信息包括win10

Returns

string

halt()

halt(mixed  $var) 

调试变量并且中断输出

Parameters

mixed $var

调试变量或者信息

HandleError()

HandleError(  $erro = '系统错误') 

Parameters

$erro

has_action()

has_action(string  $module, string  $controller, string  $action) : \number

是否存在方法

Parameters

string $module

模块

string $controller

待判定控制器名

string $action

待判定控制器名

Returns

\number —

方法结果,0不存在控制器 1存在控制器但是不存在方法 2存在控制和方法

has_controller()

has_controller(string  $module, string  $controller) : boolean

是否存在控制器

Parameters

string $module

模块

string $controller

待判定控制器名

Returns

boolean

hook()

hook(string  $name = '', mixed  $params = null, boolean  $once = false) 

监听钩子

Parameters

string $name

钩子名称

mixed $params

传入参数

boolean $once

只获取一个有效返回值

html_trim()

html_trim(string  $html, integer  $max, string  $suffix = '...') : \string;

截取待html的文本

Parameters

string $html
integer $max
string $suffix

Returns

\string;

input()

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

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

Parameters

string $key

获取的变量名

mixed $default

默认值

string $filter

过滤方法

Returns

mixed

is_assoc()

is_assoc(array  $arr) : boolean

判断是否关联数组

Parameters

array $arr

Returns

boolean

jiami()

jiami(string  $txt, string  $key = null) : string

加密函数

Parameters

string $txt

需加密的字符串

string $key

加密密钥,默认读取data_auth_key配置

Returns

string —

加密后的字符串

jiemi()

jiemi(string  $txt, string  $key = null) : string

解密函数

Parameters

string $txt

待解密的字符串

string $key

解密密钥,默认读取data_auth_key配置

Returns

string —

解密后的字符串

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

list_file()

list_file(string  $path, string  $pattern = '*') : array

列出本地目录的文件

Parameters

string $path
string $pattern

Returns

array

model()

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

实例化Model

Parameters

string $name

Model名称

string $layer

业务层名称

boolean $appendSuffix

是否添加类名后缀

Returns

\think\Model

nav_url()

nav_url(  $url) : string

Parameters

$url

Returns

string

parse_config()

parse_config(array  $temp_arr) : array

解析配置参数

Parameters

array $temp_arr

Returns

array

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

qiniuTempFile()

qiniuTempFile(  $size) 

Parameters

$size

random()

random(integer  $length = 10, string  $type = 'letter', integer  $convert) : string

随机字符

Parameters

integer $length

长度

string $type

类型

integer $convert

转换大小写 1大写 0小写

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

regular_domain()

regular_domain(  $domain) : string

Parameters

$domain

Returns

string

remove_dir()

remove_dir(  $dir,   $time_thres = -1) 

删除文件夹

Parameters

$dir
$time_thres

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

rmdirs()

rmdirs(string  $dirname, boolean  $withself = true) : boolean

删除文件夹

Parameters

string $dirname

目录

boolean $withself

是否删除自身

Returns

boolean

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

save_storage_content()

save_storage_content(string  $ext = null, string  $content = null) : array

将内容存到Storage中,返回转存后的文件路径

Parameters

string $ext
string $content

Returns

array

sendMail()

sendMail(string  $to, string  $title, string  $content) : array

发送邮件

Parameters

string $to

收件人邮箱

string $title

标题

string $content

内容

Throws

Returns

array

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

showmsg()

showmsg(string  $msg, string  $class = '') 

实时显示提示信息

Parameters

string $msg

提示信息

string $class

输出样式(success:成功,error:失败)

sort_dir()

sort_dir(  $a,   $b) 

Parameters

$a
$b

str_left()

str_left(  $str,   $zuo) 

Parameters

$str
$zuo

str_right()

str_right(  $str,   $you) 

Parameters

$str
$you

strzhong()

strzhong(  $str,   $leftStr,   $rightStr) 

Parameters

$str
$leftStr
$rightStr

sys_config_get()

sys_config_get(  $key) : array|null

获取全局配置

Parameters

$key

Returns

array|null

sys_config_setbyarr()

sys_config_setbyarr(  $data) : boolean

设置全局配置到文件

Parameters

$data

Returns

boolean

sys_config_setbykey()

sys_config_setbykey(  $key,   $value) : boolean

设置全局配置到文件

Parameters

$key
$value

Returns

boolean

testwrite()

testwrite(string  $d) : boolean

测试读写

Parameters

string $d

Returns

boolean

token()

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

生成表单令牌

Parameters

string $name

令牌名称

mixed $type

令牌生成方法

Returns

string

top_domain()

top_domain(  $domain) : string

Parameters

$domain

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

trait_uses_recursive()

trait_uses_recursive(string  $trait) : array

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

Parameters

string $trait

Returns

array

tree_left()

tree_left(array|mixed  $tree, string  $id_field = 'id', string  $pid_field = 'pid', string  $lefthtml = '─', integer  $pid, integer  $lvl, integer  $leftpin) : array

返回按层级加前缀的树形数组

Parameters

array|mixed $tree

待处理菜单数组

string $id_field

主键id字段名

string $pid_field

父级字段名

string $lefthtml

前缀

integer $pid

父级id

integer $lvl

当前lv

integer $leftpin

左侧距离

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