PHP 클래스 callmez\wechat\sdk\components\BaseWechat

상속: extends yii\base\Component
파일 보기 프로젝트 열기: callmez/yii2-wechat-sdk 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$cachePrefix string 数据缓存前缀
$itemTag the name of the elements that represent the array elements with numeric keys.
$lastError array 返回错误码

공개 메소드들

메소드 설명
decryptXml ( string $xml, string $messageSignature, string $timestamp, string $nonce ) : string | boolean 解密XML数据
encryptXml ( string $xml, string $timestamp, string $nonce ) : string | boolean 加密XML数据
getAccessToken ( boolean $force = false ) : mixed 获取AccessToken 超时后会自动重新获取AccessToken并触发self::EVENT_AFTER_ACCESS_TOKEN_UPDATE事件
getJsApiTicket ( boolean $force = false ) : mixed 获取js api ticket 超时后会自动重新获取JsApiTicket并触发self::EVENT_AFTER_JS_API_TICKET_UPDATE事件
getMessageCrypt ( ) : callmez\wechat\sdk\components\MessageCrypt 设置消息加密处理类
httpGet ( $url, array $options = [] ) : mixed Http Get 请求
httpPost ( $url, array $postOptions, array $options = [] ) : mixed Http Post 请求
httpRaw ( $url, $postOptions, array $options = [] ) : mixed Http Raw数据 Post 请求
jsApiConfig ( array $config = [] ) 生成js 必要的config
parseHttpRequest ( callable $callable, string $url, array | string | null $postOptions = null ) : array | boolean 解析微信请求响应内容
setAccessToken ( array $accessToken ) 设置AccessToken
setJsApiTicket ( array $jsApiTicket ) 设置JsApiTicket
setMessageCrypt ( callmez\wechat\sdk\components\MessageCrypt $messageCrypt ) 设置消息加密处理类
xml ( array $data, null $charset = null ) : string 创建微信格式的XML

보호된 메소드들

메소드 설명
buildXml ( $element, $data )
createMessageCrypt ( ) : mixed 创建消息加密类
getCache ( $name ) : mixed 获取微信缓存数据
getCacheKey ( $name ) : string 微信数据缓存基本键值
http ( $url, array $options = [] ) : boolean | mixed Http基础库 使用该库请求微信服务器
httpBuildQuery ( $url, array $options ) : string Api url 组装
requestAccessToken ( ) : array | boolean 请求微信服务器获取AccessToken 必须返回以下格式内容 [ 'access_token => 'xxx', 'expirs_in' => 7200 ]
requestJsApiTicket ( ) : array | boolean 请求微信服务器获取JsApiTicket 必须返回以下格式内容 [ 'ticket => 'xxx', 'expirs_in' => 7200 ]
setCache ( $name, $value, null $duration = null ) : boolean 缓存微信数据
uploadFile ( $filePath ) : CURLFile | string 上传文件请使用该类来解决curl版本兼容问题

메소드 상세

buildXml() 보호된 메소드

또한 보기: yii\web\XmlResponseFormatter::buildXml()
protected buildXml ( $element, $data )

createMessageCrypt() 추상적인 보호된 메소드

创建消息加密类
abstract protected createMessageCrypt ( ) : mixed
리턴 mixed

decryptXml() 공개 메소드

解密XML数据
public decryptXml ( string $xml, string $messageSignature, string $timestamp, string $nonce ) : string | boolean
$xml string 解密的XML
$messageSignature string 加密签名
$timestamp string 加密时间戳
$nonce string 加密随机串
리턴 string | boolean

encryptXml() 공개 메소드

加密XML数据
public encryptXml ( string $xml, string $timestamp, string $nonce ) : string | boolean
$xml string 加密的XML
$timestamp string 加密时间戳
$nonce string 加密随机串
리턴 string | boolean

getAccessToken() 공개 메소드

获取AccessToken 超时后会自动重新获取AccessToken并触发self::EVENT_AFTER_ACCESS_TOKEN_UPDATE事件
public getAccessToken ( boolean $force = false ) : mixed
$force boolean 是否强制获取
리턴 mixed

getCache() 보호된 메소드

获取微信缓存数据
protected getCache ( $name ) : mixed
$name
리턴 mixed

getCacheKey() 추상적인 보호된 메소드

微信数据缓存基本键值
abstract protected getCacheKey ( $name ) : string
$name
리턴 string

getJsApiTicket() 공개 메소드

获取js api ticket 超时后会自动重新获取JsApiTicket并触发self::EVENT_AFTER_JS_API_TICKET_UPDATE事件
public getJsApiTicket ( boolean $force = false ) : mixed
$force boolean 是否强制获取
리턴 mixed

getMessageCrypt() 공개 메소드

设置消息加密处理类
public getMessageCrypt ( ) : callmez\wechat\sdk\components\MessageCrypt
리턴 callmez\wechat\sdk\components\MessageCrypt

http() 보호된 메소드

Http基础库 使用该库请求微信服务器
protected http ( $url, array $options = [] ) : boolean | mixed
$url
$options array
리턴 boolean | mixed

httpBuildQuery() 보호된 메소드

Api url 组装
protected httpBuildQuery ( $url, array $options ) : string
$url
$options array
리턴 string

httpGet() 공개 메소드

Http Get 请求
public httpGet ( $url, array $options = [] ) : mixed
$url
$options array
리턴 mixed

httpPost() 공개 메소드

Http Post 请求
public httpPost ( $url, array $postOptions, array $options = [] ) : mixed
$url
$postOptions array
$options array
리턴 mixed

httpRaw() 공개 메소드

Http Raw数据 Post 请求
public httpRaw ( $url, $postOptions, array $options = [] ) : mixed
$url
$postOptions
$options array
리턴 mixed

jsApiConfig() 추상적인 공개 메소드

生成js 必要的config
abstract public jsApiConfig ( array $config = [] )
$config array

parseHttpRequest() 추상적인 공개 메소드

解析微信请求响应内容
abstract public parseHttpRequest ( callable $callable, string $url, array | string | null $postOptions = null ) : array | boolean
$callable callable Http请求主体函数
$url string Api地址
$postOptions array | string | null Api地址一般所需要的post参数
리턴 array | boolean

requestAccessToken() 추상적인 보호된 메소드

请求微信服务器获取AccessToken 必须返回以下格式内容 [ 'access_token => 'xxx', 'expirs_in' => 7200 ]
abstract protected requestAccessToken ( ) : array | boolean
리턴 array | boolean

requestJsApiTicket() 추상적인 보호된 메소드

请求微信服务器获取JsApiTicket 必须返回以下格式内容 [ 'ticket => 'xxx', 'expirs_in' => 7200 ]
abstract protected requestJsApiTicket ( ) : array | boolean
리턴 array | boolean

setAccessToken() 공개 메소드

设置AccessToken
public setAccessToken ( array $accessToken )
$accessToken array

setCache() 보호된 메소드

缓存微信数据
protected setCache ( $name, $value, null $duration = null ) : boolean
$name
$value
$duration null
리턴 boolean

setJsApiTicket() 공개 메소드

设置JsApiTicket
public setJsApiTicket ( array $jsApiTicket )
$jsApiTicket array

setMessageCrypt() 공개 메소드

设置消息加密处理类
public setMessageCrypt ( callmez\wechat\sdk\components\MessageCrypt $messageCrypt )
$messageCrypt callmez\wechat\sdk\components\MessageCrypt

uploadFile() 보호된 메소드

上传文件请使用该类来解决curl版本兼容问题
protected uploadFile ( $filePath ) : CURLFile | string
$filePath
리턴 CURLFile | string

xml() 공개 메소드

创建微信格式的XML
public xml ( array $data, null $charset = null ) : string
$data array
$charset null
리턴 string

프로퍼티 상세

$cachePrefix 공개적으로 프로퍼티

数据缓存前缀
public string $cachePrefix
리턴 string

$itemTag 공개적으로 프로퍼티

the name of the elements that represent the array elements with numeric keys.
public $itemTag

$lastError 공개적으로 프로퍼티

返回错误码
public array $lastError
리턴 array