ACTION_NAME
ACTION_NAME = $action
Aliyun |
app |
Composer |
miniprogram |
Qcloud |
Qiniu |
tests |
think |
traits |
Workerman |
ILogHandler |
CLogFileHandler | |
ComposerAutoloaderInit0d7b6b2bb5080df24d5801ed35e852f6 | |
Error | |
ErrorCode | error code 仅用作类内部使用,不用于官方API接口的errCode码 |
FrameFiller | |
FrameFiller | |
JsApiPay | JSAPI支付实现类 该类实现了从微信公众平台获取code、通过code获取openid和access_token、 生成jsapi支付js接口所需的参数、生成获取共享收货地址所需的参数 |
JSSDK | |
Log | |
MicroPay | 刷卡支付实现类 该类实现了一个刷卡支付的流程,流程如下: 1、提交刷卡支付 2、根据返回结果决定是否需要查询订单,如果查询之后订单还未变则需要返回查询(一般反复查10次) 3、如果反复查询10订单依然不变,则发起撤销订单 4、撤销订单需要循环撤销,一直撤销成功为止(注意循环次数,建议10次) |
NativeNotifyCallBack | 回调基础类 |
NativePay | 刷卡支付实现类 |
PayNotifyCallBack | 回调基础类 |
PKCS7Encoder | PKCS7Encoder class |
Prpcrypt | Prpcrypt class |
QRbitstream | |
QRbitstream | |
QRcode | |
QRcode | |
QRencode | |
QRencode | |
QRimage | |
QRimage | |
QRinput | |
QRinput | |
QRinputItem | |
QRinputItem | |
QRmask | |
QRmask | |
QRrawcode | |
QRrawcode | |
QRrs | |
QRrs | |
QRrsblock | |
QRrsblock | |
QRrsItem | |
QRrsItem | |
QRspec | |
QRspec | |
QRsplit | |
QRsplit | |
qrstr | |
qrstr | |
QRtools | |
QRtools | |
Redpack | 现金红包类 参数以及使用方法请查看发红包函数 |
Tree | |
Uploader | Created by JetBrains PhpStorm. |
微信公众平台PHP-SDK, 官方API部分 | |
wxPay | 微信支付企业付款接口 |
WxPayApi | 接口访问类,包含所有微信支付API列表的封装,类中方法为static方法, 每个接口有默认超时时间(除提交被扫支付为10s,上报超时时间为1s外,其他均为6s) |
WxPayBizPayUrl | 扫码支付模式一生成二维码参数 |
WxPayCloseOrder | 关闭订单输入对象 |
WxPayConfig | 配置账号信息 |
WxPayDataBase | 数据对象基础类,该类中定义数据类最基本的行为,包括: 计算/设置/获取签名、输出xml格式的参数、从xml读取数据对象等 |
WxPayDownloadBill | 下载对账单输入对象 |
WxPayException | 微信支付API异常类 |
WxPayJsApiPay | 提交JSAPI输入对象 |
WxPayMicroPay | 提交被扫输入对象 |
WxPayNotify | 回调基础类 |
WxPayNotifyReply | 回调基础类 |
WxPayOrderQuery | 订单查询输入对象 |
WxPayRefund | 提交退款输入对象 |
WxPayRefundQuery | 退款查询输入对象 |
WxPayReport | 测速上报输入对象 |
WxPayResults | 接口调用结果类 |
WxPayReverse | 撤销输入对象 |
WxPayShortUrl | 短链转换输入对象 |
WxPayUnifiedOrder | 统一下单输入对象 |
abort(integer|\think\Response $code, string $message = null, array $header = array())
抛出HTTP异常
integer|\think\Response | $code | 状态码 或者 Response对象实例 |
string | $message | 错误信息 |
array | $header | 参数 |
app(string $name = 'think\App', array $args = array(), boolean $newInstance = false) : mixed|\think\App
快速获取容器中的实例 支持依赖注入
string | $name | 类名或标识 默认获取当前应用实例 |
array | $args | 参数 |
boolean | $newInstance | 是否每次创建新的实例 |
bind(string $abstract, mixed $concrete = null) : \think\Container
绑定一个类到容器
string | $abstract | 类标识、接口 |
mixed | $concrete | 要绑定的类、闭包或者实例 |
captcha(string $id = '', array $config = array()) : \think\Response
string | $id | |
array | $config |
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"
container() : \think\Container
获取容器对象实例
controller(string $name, string $layer = 'controller', boolean $appendSuffix = false) : \think\Controller
实例化控制器 格式:[模块/]控制器
string | $name | 资源地址 |
string | $layer | 控制层名称 |
boolean | $appendSuffix | 是否添加类名后缀 |
createMpMenu(array $data = array())
创建菜单(认证后的订阅号可用)
array | $data | 菜单数组数据 type可以选择为以下几种,其中5-8除了收到菜单事件以外,还会单独收到对应类型的信息。 1、click:点击推事件 2、view:跳转URL 3、scancode_push:扫码推事件 4、scancode_waitmsg:扫码推事件且弹出“消息接收中”提示框 5、pic_sysphoto:弹出系统拍照发图 6、pic_photo_or_album:弹出拍照或者相册发图 7、pic_weixin:弹出微信相册发图器 8、location_select:弹出地理位置选择器 |
db(string $name = '', array|string $config = array(), boolean $force = true) : \think\db\Query
实例化数据库类
string | $name | 操作的数据表名称(不含前缀) |
array|string | $config | 数据库配置参数 |
boolean | $force | 是否强制重新连接 |
download(string $filename, string $name = '', boolean $content = false, integer $expire = 360, $openinBrowser = false) : \think\response\Download
获取\think\response\Download对象实例
string | $filename | 要下载的文件 |
string | $name | 显示文件名 |
boolean | $content | 是否为内容 |
integer | $expire | 有效期(秒) |
$openinBrowser |
get_qrcode(integer|string $scene_id, integer $type, integer $expire = 604800) : \array('ticket'=>'qrcode字串','expire_seconds'=>604800,'url'=>'二维码图片解析后的地址')
创建二维码ticket
integer|string | $scene_id | 自定义追踪id,临时二维码只能用数值型 |
integer | $type | 0:临时二维码;1:永久二维码(此时expire参数无效);2:永久二维码(此时expire参数无效) |
integer | $expire | 临时二维码有效期,最大为604800秒 |
getForeverMaterial(string $type, integer $offset, integer $count) : boolean|array
获取永久素材列表(认证后的订阅号可用)
string | $type | 素材的类型,图片(image)、视频(video)、语音 (voice)、图文(news) |
integer | $offset | 全部素材的偏移位置,0表示从第一个素材 |
integer | $count | 返回素材的数量 |
返回数组格式: array( 'total_count'=>0, //该类型的素材的总数 'item_count'=>0, //本次调用获取的素材的数量 'item'=>array() //素材列表数组,内容定义请参考官方文档 )
getMemberInfo(string $openid = '', $field = array()) : array|false|\PDOStatement|string|\think\Model
string | $openid | |
$field |
getMimiappInfo(string $mid = '', integer $expier = 1800) : array|mixed|null|\PDOStatement|string|\think\Model
//获取小程序信息也可以使用 getMpInfo 这个函数
string | $mid | 小程序标识 |
integer | $expier | 缓存时间 |
getMiniProgramObj(array $options = array()) : \miniprogram\MiniProgram
array | $options |
getMpInfo(string $mid = '', string $type = 'mp', integer $expier = 1800) : mixed
string | $mid | 获取公众号|小程序信息 |
string | $type | 公众号为mp,小程序为miniapp,默认获取公众号信息 |
integer | $expier | 缓存有效期 默认1800S |
json(mixed $data = array(), integer $code = 200, array $header = array(), array $options = array()) : \think\response\Json
获取\think\response\Json对象实例
mixed | $data | 返回的数据 |
integer | $code | 状态码 |
array | $header | 头部 |
array | $options | 参数 |
jsonp(mixed $data = array(), integer $code = 200, array $header = array(), array $options = array()) : \think\response\Jsonp
获取\think\response\Jsonp对象实例
mixed | $data | 返回的数据 |
integer | $code | 状态码 |
array | $header | 头部 |
array | $options | 参数 |
model(string $name = '', string $layer = 'model', boolean $appendSuffix = false) : \think\Model
实例化Model
string | $name | Model名称 |
string | $layer | 业务层名称 |
boolean | $appendSuffix | 是否添加类名后缀 |
rand_string(string $len = 6, string $type = '', string $addChars = '') : string
+---------------------------------------------------------- 产生随机字串,可用来自动生成密码 默认长度6位 字母和数字混合 +----------------------------------------------------------
string | $len | 长度 |
string | $type | 字串类型 0 字母 1 数字 其它 混合 |
string | $addChars | 额外字符 +---------------------------------------------------------- |
+----------------------------------------------------------
redirect(mixed $url = array(), array|integer $params = array(), integer $code = 302) : \think\response\Redirect
获取\think\response\Redirect对象实例
mixed | $url | 重定向地址 支持Url::build方法的地址 |
array|integer | $params | 额外参数 |
integer | $code | 状态码 |
request() : \think\facade\Request
获取当前Request对象实例
response(mixed $data = '', integer|string $code = 200, array $header = array(), string $type = 'html') : \think\Response
创建普通 Response 对象实例
mixed | $data | 输出数据 |
integer|string | $code | 状态码 |
array | $header | 头信息 |
string | $type |
route(string $rule, mixed $route, array $option = array(), array $pattern = array()) : \think\route\RuleItem
路由注册
string | $rule | 路由规则 |
mixed | $route | 路由地址 |
array | $option | 路由参数 |
array | $pattern | 变量规则 |
sendGroupMassMessage(array $data) : boolean|array
高级群发消息, 根据群组id群发图文消息(认证后的订阅号可用) 注意:视频需要在调用uploadMedia()方法后,再使用 uploadMpVideo() 方法生成, 然后获得的 mediaid 才能用于群发,且消息类型为 mpvideo 类型。
array | $data | 消息结构 { "filter"=>array( "is_to_all"=>False, //是否群发给所有用户.True不用分组id,False需填写分组id "group_id"=>"2" //群发的分组id ), "msgtype"=>"mpvideo", // 在下面5种类型中选择对应的参数内容 // mpnews | voice | image | mpvideo => array( "media_id"=>"MediaId") // text => array ( "content" => "hello") } |
sendTemplateMessage(array $data = array()) : boolean|array
发送模板消息
array | $data | 消息结构 { "touser":"OPENID", "template_id":"ngqIpbwh8bUfcSsECmogfXcV14J0tQlEpBO27izEYtY", "url":"http://weixin.qq.com/download", "topcolor":"#FF0000", "data":{ "参数名1": { "value":"参数", "color":"#173177" //参数颜色 }, "Date":{ "value":"06月07日 19时24分", "color":"#173177" }, "CardNumber":{ "value":"0426", "color":"#173177" }, "Type":{ "value":"消费", "color":"#173177" } } } |
singleSmsByAli( $mid, $PhoneNumbers, $SignName, $TemplateCode, array $TemplateParam = array(), string $OutId = '', string $SmsUpExtendCode = '') : boolean|mixed|\stdClass|string
$mid | ||
$PhoneNumbers | 必填: 短信接收号码 |
|
$SignName | 必填: 短信签名,应严格按"签名名称"填写,请参考: https://dysms.console.aliyun.com/dysms.htm#/develop/sign |
|
$TemplateCode | 必填: 短信模板Code,应严格按"模板CODE"填写, 请参考: https://dysms.console.aliyun.com/dysms.htm#/develop/template |
|
array | $TemplateParam | 必填: 设置模板参数, 假如模板中存在变量需要替换则为必填项 |
string | $OutId | 可选: 设置发送短信流水号 |
string | $SmsUpExtendCode | 可选: 上行短信扩展码, 扩展码字段控制在7位或以下,无特殊需求用户请忽略此字段 |
singleSmsByTx( $mid = '', string $phoneNumber = '', string $msg = '', integer $type = '0', string $nationCode = '86', string $extend = "", string $ext = "") : string
普通单发,明确指定内容,如果有多个签名,请在内容中以【】的方式添加到信息内容中,否则系统将使用默认签名
$mid | ||
string | $phoneNumber | 不带国家码的手机号 |
string | $msg | 信息内容,必须与申请的模板格式一致,否则将返回错误 |
integer | $type | 短信类型,0 为普通短信,1 营销短信 |
string | $nationCode | 国家码,如 86 为中国 |
string | $extend | 扩展码,可填空串 |
string | $ext | 服务端原样返回的参数,可填空串 |
json string { "result": xxxxx, "errmsg": "xxxxxx" ... },被省略的内容参见协议文档
uploadForeverMedia( $filePath = '', $type, boolean $is_video = false, array $video_info = array()) : boolean|array
上传永久素材(认证后的订阅号可用) 新增的永久素材也可以在公众平台官网素材管理模块中看到 $param string filePath 注意是物理路径
$filePath | ||
$type | ||
boolean | $is_video | 是否为视频文件,默认为否 |
array | $video_info | 视频信息数组,非视频素材不需要提供 array('title'=>'视频标题','introduction'=>'描述') |
validate(string $name = '', string $layer = 'validate', boolean $appendSuffix = false) : \think\Validate
实例化验证器
string | $name | 验证器名称 |
string | $layer | 业务层名称 |
boolean | $appendSuffix | 是否添加类名后缀 |
view(string $template = '', array $vars = array(), integer $code = 200, callable $filter = null) : \think\response\View
渲染模板输出
string | $template | 模板文件 |
array | $vars | 模板变量 |
integer | $code | 状态码 |
callable | $filter | 内容过滤 |
xml(mixed $data = array(), integer $code = 200, array $header = array(), array $options = array()) : \think\response\Xml
获取\think\response\Xml对象实例
mixed | $data | 返回的数据 |
integer | $code | 状态码 |
array | $header | 头部 |
array | $options | 参数 |