AbleCloud PHP SDK  1.8.x
PHP SDK of AbleCloud API
Public 成员函数 | 静态 Public 成员函数 | 所有成员列表
ACRequest类 参考

Public 成员函数

 __construct ($serviceName, $methodName, $serviceVersion, $subDomain='')
 
 setUser ($user)
 
 getUser ()
 
 getServiceName ()
 
 getServiceVersion ()
 
 getMethodName ()
 
 getSubDomain ()
 
 addParameter ($key, $value)
 
 getParameterKeys ()
 
 getParameterValue ($key)
 
 setPayloadAsJSON ($payload, $contentType='application/x-zc-object')
 
 setPayloadAsStream ($payload)
 
 getPayloadFormat ()
 
 getPayloadSize ()
 
 getPayload ()
 
 getTraceId ()
 
 setTraceId ($traceId)
 

静态 Public 成员函数

static newTraceId ()
 

详细描述

访问AbleCloud远程服务的请求消息。

构造及析构函数说明

◆ __construct()

ACRequest::__construct (   $serviceName,
  $methodName,
  $serviceVersion,
  $subDomain = '' 
)

构造函数。

参数
$serviceNamestring 是拟访问的远程服务的名字。
$methodNamestring 是拟访问的远程服务的方法的名字。
$serviceVersionint 是拟访问的远程服务的主版本号。
$subDomainstring 是拟访问的远程服务所属的子域的名字。缺省值为空字符串,表示访问主域级别的服务。不为空字符串时,表示访问该子域所对应的服务。

成员函数说明

◆ addParameter()

ACRequest::addParameter (   $key,
  $value 
)

添加请求的参数。这些参数是键值对,将会以查询字符串的方式置于访问远程服务的URL中传递给远程服务。

参数
$keystring 参数的名字。
$valuemixed 参数的值。对同名的参数多次赋值时,取最后一次设置的值。

◆ getMethodName()

ACRequest::getMethodName ( )

取拟访问的远程服务的方法名。

返回
string 返回拟访问的远程服务的方法名。

◆ getParameterKeys()

ACRequest::getParameterKeys ( )

取设置的所有参数的名字。

返回
array 返回参数名字所形成的数组。

◆ getParameterValue()

ACRequest::getParameterValue (   $key)

取参数的值。

参数
$keystring 参数的名字。
返回
mixed|NULL 返回指定参数的值。参数不存在时返回NULL。

◆ getPayload()

ACRequest::getPayload ( )

取设置的请求所包含的数据。

返回
string 返回以string数据类型表示的数据。

◆ getPayloadFormat()

ACRequest::getPayloadFormat ( )

取请求所包含的数据的格式:application/x-zc-object或application/octet-stream,分别表示JSON格式和二进制数据格式。

返回
string 返回请求所包含的数据的格式。

◆ getPayloadSize()

ACRequest::getPayloadSize ( )

取请求所包含数据的大小。

返回
int 返回请求所包含数据的字节数。

◆ getServiceName()

ACRequest::getServiceName ( )

取拟访问的远程服务的名字。

返回
string 返回拟访问的远程服务的名字。

◆ getServiceVersion()

ACRequest::getServiceVersion ( )

取拟访问的远程服务的主版本号。

返回
int 返回拟访问的远程服务的主版本号。

◆ getSubDomain()

ACRequest::getSubDomain ( )

取拟访问的远程服务所属的子域的名字。

返回
string 回拟访问的远程服务所属的子域的名字。

◆ getTraceId()

ACRequest::getTraceId ( )

取当前的Trace-Id。

返回
string 当前的Trace-Id。

◆ getUser()

ACRequest::getUser ( )

取当前设置的用户信息。

返回
ACUser|NULL 返回NULL或ACUser对象。

◆ newTraceId()

static ACRequest::newTraceId ( )
static

生成一个Trace-ID。

返回
string 是符合RFC 4122 - Section 4.4规范的UUID的十六进制表示形式。

◆ setPayloadAsJSON()

ACRequest::setPayloadAsJSON (   $payload,
  $contentType = 'application/x-zc-object' 
)

消息内容要么是JSON格式的要么是二进制格式的。取最后一次设置的内容为最终内容。本方法用于设置JSON格式的消息内容。

参数
$payloadstring JSON格式的内容。
$contentTypestring HTTP请求的Content-Type的值,缺省为'application/x-zc-object'。

◆ setPayloadAsStream()

ACRequest::setPayloadAsStream (   $payload)

消息内容要么是JSON格式的要么是二进制格式的。取最后一次设置的内容为最终内容。本方法用于设置二进制格式的消息内容。

参数
$payloadstring string类型的数据,表示二进制格式的内容。

◆ setTraceId()

ACRequest::setTraceId (   $traceId)

设置Trace-Id。

参数
$traceIdstring 是符合RFC 4122 - Section 4.4规范的UUID的十六进制表示形式,用来作为请求的Trace-Id。

◆ setUser()

ACRequest::setUser (   $user)

设置本次请求所关联的用户。该用户是AbleCloud平台中开发者所提供服务的用户。

参数
$userACUser|NULL AbleCloud平台中开发者所提供服务的用户。NULL表示清除设置的用户信息。

该类的文档由以下文件生成: