\

Namespaces

app
Composer
controller
Endroid
OSS
Qiniu
service
Symfony
think
traits
WeChat
WeMini
WeOpen

Classes

AppKernel
Common Class Common
ComposerAutoloaderInit634fe4faf75443ee005458ef619df6f4
Config Class Config
ErrorCode error code 说明.
ErrorCode 仅用作类内部使用 不用于官方API接口的errCode码 Class ErrorCode
Ip2Region
PKCS7Encoder PKCS7算法 - 加解密 Class PKCS7Encoder
Prpcrypt 公众号消息 - 加解密 Class Prpcrypt
WXBizDataCrypt 对微信小程序用户加密数据的解密示例代码.

Constants

INDEX_BLOCK_LENGTH

INDEX_BLOCK_LENGTH = 12

QINIU_FUNCTIONS_VERSION

QINIU_FUNCTIONS_VERSION = \Qiniu\Config::SDK_VER

TOTAL_HEADER_LENGTH

TOTAL_HEADER_LENGTH = 8192

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) : object

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

Parameters

string $name

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

array $args

参数

boolean $newInstance

是否每次创建新的实例

Returns

object

attract_form_id()

attract_form_id(  $form_id) 

Parameters

$form_id

auth()

auth(string  $node) : boolean

RBAC节点权限验证

Parameters

string $node

Returns

boolean

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

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

classLoader()

classLoader(  $class) 

Parameters

$class

classLoader()

classLoader(  $class) 

Parameters

$class

composerRequire634fe4faf75443ee005458ef619df6f4()

composerRequire634fe4faf75443ee005458ef619df6f4(  $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

copyObject()

copyObject(\OSS\OssClient  $ossClient, string  $bucket) : null

拷贝object 当目的object和源object完全相同时,表示修改object的meta信息

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

createBucket()

createBucket(\OSS\OssClient  $ossClient, string  $bucket) : null

创建一个存储空间 acl 指的是bucket的访问控制权限,有三种,私有读写,公共读私有写,公共读写。 私有读写就是只有bucket的拥有者或授权用户才有权限操作 三种权限分别对应 (OssClient::OSS_ACL_TYPE_PRIVATE,OssClient::OSS_ACL_TYPE_PUBLIC_READ, OssClient::OSS_ACL_TYPE_PUBLIC_READ_WRITE)

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

要创建的存储空间名称

Returns

null

createObjectDir()

createObjectDir(\OSS\OssClient  $ossClient, string  $bucket) : null

创建虚拟目录

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

db()

db(string  $name = '', array|string  $config = array(), boolean  $force = false) : \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

decode()

decode(string  $string) : string

UTF8字符串解密

Parameters

string $string

Returns

string

deleteBucket()

deleteBucket(\OSS\OssClient  $ossClient, string  $bucket) : null

删除bucket,如果bucket不为空则bucket无法删除成功, 不为空表示bucket既没有object,也没有未完成的multipart上传时的parts

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

待删除的存储空间名称

Returns

null

deleteBucketCors()

deleteBucketCors(\OSS\OssClient  $ossClient, string  $bucket) : null

删除bucket的所有的cors配置

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

deleteBucketLifecycle()

deleteBucketLifecycle(\OSS\OssClient  $ossClient, string  $bucket) : null

删除bucket的生命周期配置

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

deleteBucketLogging()

deleteBucketLogging(\OSS\OssClient  $ossClient, string  $bucket) : null

删除bucket的Logging配置

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

deleteBucketReferer()

deleteBucketReferer(\OSS\OssClient  $ossClient, string  $bucket) : null

删除bucket的防盗链配置 Referer白名单不能直接清空,只能通过重新设置来覆盖之前的规则。

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

deleteBucketWebsite()

deleteBucketWebsite(\OSS\OssClient  $ossClient, string  $bucket) : null

删除bucket的静态网站托管模式配置

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

deleteObject()

deleteObject(\OSS\OssClient  $ossClient, string  $bucket) : null

删除object

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

deleteObjects()

deleteObjects(\OSS\OssClient  $ossClient, string  $bucket) : null

批量删除object

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

doesBucketExist()

doesBucketExist(\OSS\OssClient  $ossClient, string  $bucket) 

判断Bucket是否存在

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

doesObjectExist()

doesObjectExist(\OSS\OssClient  $ossClient, string  $bucket) : null

判断object是否存在

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

dump()

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

浏览器友好的变量输出

Parameters

mixed $var

变量

boolean $echo

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

string $label

标签 默认为空

Returns

void|string

encode()

encode(string  $string) : string

UTF8字符串加密

Parameters

string $string

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

format_datetime()

format_datetime(string  $datetime, string  $format = 'Y年m月d日 H:i:s') : false|string

日期格式标准输出

Parameters

string $datetime

输入日期

string $format

输出格式

Returns

false|string

formatTime()

formatTime(  $time) 

Parameters

$time

getBucketAcl()

getBucketAcl(\OSS\OssClient  $ossClient, string  $bucket) : null

获取bucket的acl配置

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

getBucketCors()

getBucketCors(\OSS\OssClient  $ossClient, string  $bucket) : null

获取并打印bucket的cors配置

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

getBucketLifecycle()

getBucketLifecycle(\OSS\OssClient  $ossClient, string  $bucket) : null

获取bucket的生命周期配置

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

getBucketLogging()

getBucketLogging(\OSS\OssClient  $ossClient, string  $bucket) : null

获取bucket的Logging配置

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

getBucketReferer()

getBucketReferer(\OSS\OssClient  $ossClient, string  $bucket) : null

获取bucket的防盗链配置

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

getBucketWebsite()

getBucketWebsite(\OSS\OssClient  $ossClient, string  $bucket) : null

获取bucket的静态网站托管状态

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

getdistance()

getdistance(  $lng1,   $lat1,   $lng2,   $lat2) : float

求两个已知经纬度之间的距离,单位为千米

Parameters

$lng1
$lat1
$lng2
$lat2

Returns

float —

距离,单位千米

getIp()

getIp() 

getObject()

getObject(\OSS\OssClient  $ossClient, string  $bucket) : null

获取object的内容

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

getObjectMeta()

getObjectMeta(\OSS\OssClient  $ossClient, string  $bucket) : null

获取object meta, 也就是getObjectMeta接口

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

getObjectToLocalFile()

getObjectToLocalFile(\OSS\OssClient  $ossClient, string  $bucket) : null

get_object_to_local_file

获取object 将object下载到指定的文件

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

getSignedUrlForGettingObject()

getSignedUrlForGettingObject(  $ossClient,   $bucket) : null

生成GetObject的签名url,主要用于私有权限下的读访问控制

Parameters

$ossClient

OssClient OssClient实例

$bucket

string 存储空间名称

Returns

null

getSignedUrlForPuttingObject()

getSignedUrlForPuttingObject(\OSS\OssClient  $ossClient, string  $bucket) : null

生成PutObject的签名url,主要用于私有权限下的写访问控制

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Throws

\OSS\Core\OssException

Returns

null

getSignedUrlForPuttingObjectFromFile()

getSignedUrlForPuttingObjectFromFile(\OSS\OssClient  $ossClient, string  $bucket) 

生成PutObject的签名url,主要用于私有权限下的写访问控制, 用户可以利用生成的signedUrl 从文件上传文件

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Throws

\OSS\Core\OssException

getSymlink()

getSymlink(\OSS\OssClient  $ossClient, string  $bucket) : null

获取symlink

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

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

listAllObjects()

listAllObjects(\OSS\OssClient  $ossClient, string  $bucket) : null

列出Bucket内所有目录和文件, 根据返回的nextMarker循环得到所有Objects

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

listBuckets()

listBuckets(\OSS\OssClient  $ossClient) : null

列出用户所有的Bucket

Parameters

\OSS\OssClient $ossClient

OssClient实例

Returns

null

listMultipartUploads()

listMultipartUploads(  $ossClient,   $bucket) 

获取当前未完成的分片上传列表

Parameters

$ossClient

OssClient

$bucket

string

listObjects()

listObjects(\OSS\OssClient  $ossClient, string  $bucket) : null

列出Bucket内所有目录和文件, 注意如果符合条件的文件数目超过设置的max-keys, 用户需要使用返回的nextMarker作为入参,通过 循环调用ListObjects得到所有的文件,具体操作见下面的 listAllObjects 示例

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

local_image()

local_image(string  $url) : string

下载远程文件到本地

Parameters

string $url

远程图片地址

Returns

string

location2address()

location2address(  $lat,   $lng,   $full = false) 

Parameters

$lat
$lng
$full

location_address()

location_address(  $lat,   $lng) 

Parameters

$lat
$lng

mini_decode()

mini_decode(  $code,   $iv,   $encrypted_data) 

Parameters

$code
$iv
$encrypted_data

model()

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

实例化Model

Parameters

string $name

Model名称

string $layer

业务层名称

boolean $appendSuffix

是否添加类名后缀

Returns

\think\Model

modifyMetaForObject()

modifyMetaForObject(\OSS\OssClient  $ossClient, string  $bucket) : null

修改Object Meta 利用copyObject接口的特性:当目的object和源object完全相同时,表示修改object的meta信息

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

multiuploadFile()

multiuploadFile(\OSS\OssClient  $ossClient, string  $bucket) : null

通过multipart上传文件

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

p()

p(mixed  $data, boolean  $force = false, string|null  $file = null) 

打印输出数据到文件

Parameters

mixed $data

输出的数据

boolean $force

强制替换

string|null $file

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

printImage()

printImage(  $func,   $imageFile) 

Parameters

$func
$imageFile

putBucketAcl()

putBucketAcl(\OSS\OssClient  $ossClient, string  $bucket) : null

设置bucket的acl配置

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

putBucketCors()

putBucketCors(\OSS\OssClient  $ossClient, string  $bucket) : null

设置bucket的cors配置

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

putBucketLifecycle()

putBucketLifecycle(\OSS\OssClient  $ossClient, string  $bucket) : null

设置bucket的生命周期配置

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

putBucketLogging()

putBucketLogging(\OSS\OssClient  $ossClient, string  $bucket) : null

设置bucket的Logging配置

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

putBucketReferer()

putBucketReferer(\OSS\OssClient  $ossClient, string  $bucket) : null

设置bucket的防盗链配置

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

putBucketWebsite()

putBucketWebsite(  $ossClient,   $bucket) : null

设置bucket的静态网站托管模式配置

Parameters

$ossClient

OssClient

$bucket

string 存储空间名称

Returns

null

putObject()

putObject(\OSS\OssClient  $ossClient, string  $bucket) : null

把本地变量的内容到文件

简单上传,上传指定变量的内存值作为object的内容

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

putObjectByRawApis()

putObjectByRawApis(\OSS\OssClient  $ossClient, string  $bucket) 

使用基本的api分阶段进行分片上传

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Throws

\OSS\Core\OssException

putSymlink()

putSymlink(\OSS\OssClient  $ossClient, string  $bucket) : null

put symlink

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

qiniuTempFile()

qiniuTempFile(  $size) 

Parameters

$size

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

send_template_msg()

send_template_msg(  $msg,   $from_address) 

Parameters

$msg
$from_address

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

square_point()

square_point(  $lng,   $lat,   $distance = 0.5) : array

计算某个经纬度的周围某段距离的正方形的四个点

Parameters

$lng
$lat
$distance

Returns

array —

正方形的四个点的经纬度坐标

sysconf()

sysconf(string  $name, boolean  $value = null) : string|boolean

设备或配置系统参数

Parameters

string $name

参数名称

boolean $value

默认是null为获取值,否则为更新

Throws

\think\Exception
\think\exception\PDOException

Returns

string|boolean

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

uid()

uid() : mixed

Returns

mixed —

返回用户id

uploadDir()

uploadDir(\OSS\OssClient  $ossClient, string  $bucket) 

按照目录上传文件

Parameters

\OSS\OssClient $ossClient

OssClient

string $bucket

存储空间名称

uploadFile()

uploadFile(\OSS\OssClient  $ossClient, string  $bucket) : null

上传指定的本地文件内容

Parameters

\OSS\OssClient $ossClient

OssClient实例

string $bucket

存储空间名称

Returns

null

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