我最近开始使用SOAP,但发现很难理解抽象复杂类型的使用。
我试图将一个请求放到一个wsdl中,但我一直得到错误。'指定的类型是抽象的: name="HomeAffairsIDVRequestedBase".
我的php如下。
$result = $this->soap->__soapCall('PlaceRequest',array('PlaceRequest'=>
array('request' =>
array(
'type'=> 'tns:HomeAffairsIDVStandardRequest',
"IsBatchSearch"=>false,
"ParentRequestId"=>0,
"Reference"=>'test',
"Requester"=>'axxess',
"SessionId"=>'true',
"IdNumber"=>$this->idNumber
))));
而目标wsdl部分如下所示
<s:element name="PlaceRequest">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="request" type="tns:HomeAffairsIDVRequestBase"/>
</s:sequence>
</s:complexType>
</s:element>
<s:complexType name="HomeAffairsIDVRequestBase" abstract="true">
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="IsBatchSearch" type="s:boolean"/>
<s:element minOccurs="1" maxOccurs="1" name="ParentRequestId" nillable="true" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="Reference" type="s:string"/>
<s:element minOccurs="0" maxOccurs="1" name="Requester" type="s:string"/>
<s:element minOccurs="1" maxOccurs="1" name="SessionId" nillable="true" type="s1:guid"/>
</s:sequence>
</s:complexType>
<s:complexType name="HomeAffairsIDVRequest" abstract="true">
<s:complexContent mixed="false">
<s:extension base="tns:HomeAffairsIDVRequestBase">
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="IdNumber" type="s:string"/>
</s:sequence>
</s:extension>
</s:complexContent>
</s:complexType>
<s:complexType name="HomeAffairsIDVStandardRequest">
<s:complexContent mixed="false">
<s:extension base="tns:HomeAffairsIDVRequest"/>
</s:complexContent>
</s:complexType>
<s:complexType name="HomeAffairsIDVAdvancedRequest">
<s:complexContent mixed="false">
<s:extension base="tns:HomeAffairsIDVRequest"/>
</s:complexContent>
</s:complexType>
注意:我不能编辑wsdl。
你可以从wsdl中读取复杂类型定义作为php类定义。每个复杂类型都是一个php值对象。抽象复杂类型是抽象的值对象,它可以被继承。
当我们定义了复杂类型后,我们就可以建立我们的php类了。
abstract class HomeAffairsIDVRequestBase
{
protected bool $IsBatchSearch;
protected int $ParentRequestId;
protected ?string $Reference;
protected ?string $Requester;
protected string $SessionId;
public function getIsBatchSearch(): bool
{
return $this->IsBatchSearch;
}
public function setIsBatchSearch(bool $isBatchSearch): self
{
$this->isBatchSearch = $isBatchSearch;
return $this;
}
public function getParentRequestId(): int
{
return $this->ParentRequestId;
}
public function setParentRequestId(int $parentRequestId): self
{
$this->ParentRequestId = $parentRequestId;
return $this;
}
public function getReference(): ?string
{
return $this->Reference;
}
public function setReference(string $reference): self
{
$this->Reference = $reference;
return $this;
}
public function getRequester(): ?string
{
return $this->Requester;
}
public function setRequester(string $requester): self
{
$this->Requester = $requester;
return $this;
}
public function getSessionId(): string
{
return $this->SessionId;
}
public function setSessionId(string $sessionId): self
{
$this->SessionId = $sessionId;
return $this;
}
}
这是我们第一个抽象复合类型的定义 HomeAffairsIDVRequestBase
作为一个抽象的php类. 正如你所看到的,这个抽象类拥有所有的属性,这些属性在wsdl文件中为这个复杂的类型定义。除此之外,我们还有getter和setter方法来更好的处理类的属性。
当我们看一下这个抽象类的定义 HomeAffairsIDVStandardRequest
我们可以看到,它继承了 HomeAffairsIDVRequest
. 考虑到这一点,我们必须写到更多的php类。
abstract class HomeAffairsIDVRequest extends HomeAffairsIDVRequestBase
{
protected ?string $IdNumber;
public function getIdNumber(): ?string
{
return $this->IdNumber;
}
public function setIdNumber(?string $idNumber): self
{
$this->IdNumber = $idNumber;
return $this;
}
}
class HomeAffairsIDVStandardRequest extends HomeAffairsIDVRequest
{
}
因为其中一个复杂的类型 HomeAffairsIDVStandardRequest
和 HomeAffairsIDVAdvancedRequest
是不抽象的, wie可以使用这个类进行请求. 请注意,抽象的php类不能直接初始化。wsdl中的抽象复杂类型也一样。
现在我们需要将request元素作为一个类。这就是我们的父元素在soap请求中的作用。这个 PlaceRequest
元素只有一个属性,叫做 request
. 由于该元素是对 HomeAffairsIDVRequestBase
而这个定义是抽象的,所以我们必须在后面的请求中使用类型属性。
class PlaceRequest
{
protected HomeAffairsIDVRequestBase $request;
public function getRequest(): HomeAffairsIDVRequestBase
{
return $this->request;
}
public function setRequest(HomeAffairsIDVRequestBase $request): self
{
$this->request = $request;
return $this;
}
}
到目前为止,我们的数据结构是PHP值对象。这就是我们目前所需要的。现在让我们看看一个可能的请求。
try {
$wsdl = 'https://path.to.your.wsdl.file.com?wsdl';
$client = new SoapClient($wsdl, [
'exceptions' => true,
'trace' => true,
]);
// initialize our value object
$standard = (new HomeAffairsIDVStandardRequest())
->setIsBatchSearch(false)
->setParentRequestId(0)
->setReference('test')
->setRequester('requester')
->setSessionId('true')
->setIdNumber($idNumber);
// initialize our request element
$request = (new PlaceRequest())
->setRequest($standard);
$response = $client->placeRequest($request);
} catch (SoapFault $fault) {
// error handling like var_dump($fault)
}
由于我没有看到整个wsdl内容,我不能说,请求的XML应该是怎样的。它可能发生,上面显示的结束在一个肥皂故障。在这种情况下,尝试下面的例子。
改变类型提示,在 PlaceRequest
类。
class PlaceRequest
{
protected SoapVar $request;
public function getRequest(): SoapVar
{
return $this->request;
}
public function setRequest(SoapVar $request): self
{
$this->request = $request;
return $this;
}
}
之后,创建一个新的SoapVar实例,并将其与 $standard
的例子。
// we 've already defined the $standard object above (sets an type attribute for the request node)
$standard = new SoapVar($standard, SOAP_ENC_OBJECT, 'HomeAffairsIDVStandardRequest', 'http://your.namespace.tld/namespace', 'request', 'http://your.namespace.tld/namespace');
// initialise the request element and set the soap var parameter
$request = (new PlaceRequest())
->setRequest($standard);
// send it via soap client
$client->PlaceRequest($request);
作为额外的信息,你应该经常查看发送的xml和接收的xml,以便更好地了解错误处理情况。我们已经设置了 trace
选项时,初始化soap客户端。这使我们能够看到,最后的请求和最后的响应是什么。
...
} catch (SoapFault $fault) {
if ($client) {
// get last request
var_dump($client->__getLastRequest());
// get last response
var_dump($client->__getLastResponse());
}
}