class AopClient

Aop = Ali Open Platform 文档地址: https://opendocs.alipay.com/common/02nk10

Traits

AppTrait

Properties

protected Resp $error error from  AppTrait
protected Resp $success success from  AppTrait
string $appId
string $rsaPrivateKey
string $alipayRsaPublicKeyString
string $signType
protected string $alipaySdkVersion

Methods

getError()

获取错误

from  AppTrait
bool
setError(string|MessageBag $error)

设置错误

from  AppTrait
getSuccess()

Get success messages;

from  AppTrait
bool
setSuccess(Resp|string $success)

No description

from  AppTrait
setEnv($env = 'sandbox')

No description

$this
setAppId($app_id)

设置应用id

$this
setRsaPrivateKey($rsa_private_key)

设置私钥, 去头去尾去回车,一行字符串

$this
setRsaPublicKey($rsa_public_key)

设置公钥

$this
setPostCharset($str)

设置文件编码格式

$this
setSingType($sign_type)

设置加密方式

$this
setPrivateKeyPath($private_key_path)

设置私钥文件路径

$this
setPublicKeyPath($public_key_path)

设置支付宝公钥路径

getPublicKeyPath()

No description

string
generateSign($params, string $signType = 'RSA2')

获取验签码

string
getSignContent(array $params)

获取参数内容

string
getSignContentUrlEncode(array $params)

此方法对value做urlEncode

string
aloneRsaSign(string $data, string $privateKey, string $signType = 'RSA', bool $keyFromFile = false)

RSA单独签名方法,未做字符串处理,字符串处理见getSignContent()

bool|mixed|SimpleXMLElement
execute(object $request, null $authToken = null, null $appInfoAuthToken = null)

开始执行

mixed|string
charset($data, $targetCharset)

转换字符集编码

null
parserResponseSubCode(object $request, $responseContent, $respObject, $format)

No description

parserJSONSignData($request, $responseContent, $responseJSON)

No description

null|string
parserJSONSignSource(object $request, $responseContent)

No description

null|string
parserJSONSource($responseContent, $nodeName, $nodeIndex)

No description

mixed
parserJSONSign($responseJSon)

No description

parserXMLSignData($request, $responseContent)

No description

null|string
parserXMLSignSource(object $request, $responseContent)

No description

null|string
parserXMLSource($responseContent, $nodeName, $nodeIndex)

No description

null|string
parserXMLSign($responseContent)

No description

checkResponseSign($request, $signData, $resp, $respObject)

检查返回的验签值是否正确

string
pageExecute(object $request, string $http_method = 'POST')

页面提交执行方法

printDebug($content)

No description

openDebug()

Open Debug.

bool
rsaCheckV1(array $params)

rsaCheckV1 & rsaCheckV2 验证签名 在使用本方法前,必须初始化AopClient且传入公钥参数。 公钥是否是读取字符串还是读取文件,是根据初始化传入的值判断的。

rsaCheckV2($params)

No description

bool
verify($data, $sign, string $signType = 'RSA')

No description

string
sdkExecute(object $request)

生成用于调用收银台SDK的字符串

string
sign($data, string $signType = 'RSA2')

对数据进行加密

mixed
curl($url, null $postFields = null)

No description

float
getMillisecond()

No description

bool
checkEmpty($value)

校验$value是否非空 if not set ,return true; if is null , return true;

Details

in AppTrait at line 32
Resp getError()

获取错误

Return Value

Resp

in AppTrait at line 45
bool setError(string|MessageBag $error)

设置错误

Parameters

string|MessageBag $error error

Return Value

bool

in AppTrait at line 82
Resp getSuccess()

Get success messages;

Return Value

Resp

in AppTrait at line 100
bool setSuccess(Resp|string $success)

No description

Parameters

Resp|string $success 设置的成功信息

Return Value

bool

at line 113
setEnv($env = 'sandbox')

No description

Parameters

$env

at line 127
$this setAppId($app_id)

设置应用id

Parameters

$app_id

Return Value

$this

at line 140
$this setRsaPrivateKey($rsa_private_key)

设置私钥, 去头去尾去回车,一行字符串

Parameters

$rsa_private_key

Return Value

$this

at line 152
$this setRsaPublicKey($rsa_public_key)

设置公钥

Parameters

$rsa_public_key

Return Value

$this

at line 164
$this setPostCharset($str)

设置文件编码格式

Parameters

$str

Return Value

$this

at line 176
$this setSingType($sign_type)

设置加密方式

Parameters

$sign_type

Return Value

$this

at line 188
$this setPrivateKeyPath($private_key_path)

设置私钥文件路径

Parameters

$private_key_path

Return Value

$this

at line 200
$this setPublicKeyPath($public_key_path)

设置支付宝公钥路径

Parameters

$public_key_path

Return Value

$this

at line 207
getPublicKeyPath()

No description

at line 219
string generateSign($params, string $signType = 'RSA2')

获取验签码

Parameters

$params
string $signType

Return Value

string

at line 230
string getSignContent(array $params)

获取参数内容

Parameters

array $params

Return Value

string

at line 261
string getSignContentUrlEncode(array $params)

此方法对value做urlEncode

Parameters

array $params

Return Value

string

at line 296
string aloneRsaSign(string $data, string $privateKey, string $signType = 'RSA', bool $keyFromFile = false)

RSA单独签名方法,未做字符串处理,字符串处理见getSignContent()

Parameters

string $data 待签名字符串
string $privateKey

商户私钥,根据keyFromFile来判断是读取字符串还是读取文件,false:填写私钥字符串去回车和空格 true:填写私钥文件路径

string $signType

签名方式,RSA:SHA1 RSA2:SHA256

bool $keyFromFile 私钥获取方式,读取字符串还是读文件

Return Value

string

at line 335
bool|mixed|SimpleXMLElement execute(object $request, null $authToken = null, null $appInfoAuthToken = null)

开始执行

Parameters

object $request
null $authToken
null $appInfoAuthToken

Return Value

bool|mixed|SimpleXMLElement

Exceptions

Exception

at line 476
mixed|string charset($data, $targetCharset)

转换字符集编码

Parameters

$data
$targetCharset

Return Value

mixed|string

at line 497
null parserResponseSubCode(object $request, $responseContent, $respObject, $format)

No description

Parameters

object $request
$responseContent
$respObject
$format

Return Value

null

at line 540
SignData parserJSONSignData($request, $responseContent, $responseJSON)

No description

Parameters

$request
$responseContent
$responseJSON

Return Value

SignData

at line 556
null|string parserJSONSignSource(object $request, $responseContent)

No description

Parameters

object $request
$responseContent

Return Value

null|string

at line 580
null|string parserJSONSource($responseContent, $nodeName, $nodeIndex)

No description

Parameters

$responseContent
$nodeName
$nodeIndex

Return Value

null|string

at line 599
mixed parserJSONSign($responseJSon)

No description

Parameters

$responseJSon

Return Value

mixed

at line 610
SignData parserXMLSignData($request, $responseContent)

No description

Parameters

$request
$responseContent

Return Value

SignData

at line 625
null|string parserXMLSignSource(object $request, $responseContent)

No description

Parameters

object $request
$responseContent

Return Value

null|string

at line 652
null|string parserXMLSource($responseContent, $nodeName, $nodeIndex)

No description

Parameters

$responseContent
$nodeName
$nodeIndex

Return Value

null|string

at line 672
null|string parserXMLSign($responseContent)

No description

Parameters

$responseContent

Return Value

null|string

at line 703
checkResponseSign($request, $signData, $resp, $respObject)

检查返回的验签值是否正确

Parameters

$request
$signData
$resp
$respObject

Exceptions

Exception

at line 741
string pageExecute(object $request, string $http_method = 'POST')

页面提交执行方法

Parameters

object $request 跳转类接口的request
string $http_method 提交方式。两个值可选:post、get

Return Value

string 构建好的、签名后的最终跳转URL(GET)或String形式的form(POST)

Exceptions

Exception

at line 816
printDebug($content)

No description

Parameters

$content

at line 827
openDebug()

Open Debug.

at line 839
bool rsaCheckV1(array $params)

rsaCheckV1 & rsaCheckV2 验证签名 在使用本方法前,必须初始化AopClient且传入公钥参数。 公钥是否是读取字符串还是读取文件,是根据初始化传入的值判断的。

Parameters

array $params

Return Value

bool

at line 849
rsaCheckV2($params)

No description

Parameters

$params

at line 865
bool verify($data, $sign, string $signType = 'RSA')

No description

Parameters

$data
$sign
string $signType

Return Value

bool

at line 906
string sdkExecute(object $request)

生成用于调用收银台SDK的字符串

Parameters

object $request SDK接口的请求参数对象

Return Value

string

at line 946
protected string sign($data, string $signType = 'RSA2')

对数据进行加密

Parameters

$data
string $signType 加密方式

Return Value

string

at line 982
protected mixed curl($url, null $postFields = null)

No description

Parameters

$url
null $postFields

Return Value

mixed

Exceptions

Exception

at line 1045
protected float getMillisecond()

No description

Return Value

float

at line 1058
protected bool checkEmpty($value)

校验$value是否非空 if not set ,return true; if is null , return true;

Parameters

$value

Return Value

bool