martijngastkemper/camcima-soap-client

此包的最新版本(1.0.0)没有提供许可证信息。

基于 camcima/camcima-soap-client 的 PHP SoapClient 类包装器

1.0.0 2013-12-20 13:39 UTC

This package is not auto-updated.

Last update: 2024-09-24 01:41:07 UTC


README

概览

这是我对原生 PHP SOAP 客户端实现(\SoapClient)不足之处的尝试。

使用方法

实例化

<?php
$soapClient = new \Camcima\Soap\Client($wsdl, $options);

cURL 选项

此包装器使用 cURL 发出 HTTP 请求。您可以使用 cURL 选项自定义 SOAP 请求。

<?php
$curlOptions = array(
    CURLOPT_CRLF => true,
    CURLOPT_SSL_VERIFYPEER => true
);
$soapClient = new \Camcima\Soap\Client($wsdl, $options);
$soapClient->setCurlOptions($curlOptions);

但是,有一些 cURL 选项不能被覆盖,因为它们对于包装器是必需的

<?php
// Mandatory cURL Options
CURLOPT_POST => true
CURLOPT_HEADER => true

要获取当前使用的 cURL 选项

<?php
$curlOptions = $soapClient->getCurlOptions();

使用代理

如果您需要代理请求(例如调试),可以使用此方法设置代理主机和端口

<?php
$soapClient->useProxy('proxy.local', 8080);

此方法的默认主机名和端口号是 localhost8888,这是 Fiddler Web 调试代理的默认绑定(http://fiddler2.com/)。

用户代理

您可以为客户端自定义使用的用户代理

<?php
$soapClient->setUserAgent('MyUserAgent/1.0');

小写首字母

当我在开发与基于 .NET 的 Web 服务集成时,我注意到 SOAP 请求负载根元素的名称首字母总是小写的。对于其他内部元素,首字母总是大写的,这是类名的常见做法。我不知道这是否是 .NET Web 服务的规范,但无论如何,我实现了一个处理此问题的选项。

<?php
$soapClient->setLowerCaseFirst(true);

此设置的默认值为 false

保留空属性

当您将对象作为 SOAP 参数传递时,其中一些属性可能是 null(或未设置)。此客户端的默认行为是在发送请求时省略这些空属性。如果您需要发送所有属性,即使为 null,也请使用此选项

<?php
$soapClient->setKeepNullProperties(true);

此设置的默认值为 true

调试

为了调试请求和响应,您需要将调试模式设置为 true 并设置调试文件名和路径。

<?php
$soapClient->setDebug(true);
$soapClient->setDebugLogFilePath(__DIR__ . '/../../../../log/debug.log');

最后请求通信日志

您可以从最后请求中获取 HTTP 通信日志(请求和响应)。

<?php
$soapClient->getCommunicationLog();

结果类映射

PHP 原生 SOAP 客户端实现可以将 SOAP 返回映射到本地类。不幸的是,它并没有按预期工作。因此,我实现了自己的结果类映射版本。

它有两种不同的风格

使用类映射

您必须构建一个关联数组,其中结果元素作为键,相应的本地类作为值。

<?php
$soapClient = new Client($wsdlUrl);
$soapResult = $soapClient->GetCityForecastByZIP($getForecastByZip);
$resultClassmap = array(
    'GetCityForecastByZIPResult' => '\Camcima\Soap\Test\Fixtures\GetCityForecastByZIPResult',
    'ForecastResult' => '\Camcima\Soap\Test\Fixtures\ForecastResult',
    'array|Forecast' => '\Camcima\Soap\Test\Fixtures\ForecastEntry',
    'Temperatures' => '\Camcima\Soap\Test\Fixtures\Temperatures',
    'ProbabilityOfPrecipiation' => '\Camcima\Soap\Test\Fixtures\ProbabilityOfPrecipiation'
);
$getCityForecastByZIPResult = $soapClient->mapSoapResult($soapResult, 'GetCityForecastByZIPResult', $resultClassmap);

原生 SOAP 客户端将所有对象返回为标准类(StdClass),我的映射函数将它们“强制转换”为映射的本地类。此函数基于包含标准类对象的属性名称。在大多数情况下,这很好用,但当一个对象数组时,需要特殊的配置

<?php
$mapping = array(
    'array|Forecast' => '\Camcima\Soap\Test\Fixtures'
);

包含数组的属性的名称用作映射的标记。您还需要使用 array 前缀此元素名称,并使用竖线(|)分隔它们。

使用命名空间

如果所有结果类都位于同一个命名空间中,就没有必要分别映射它们。您只需告诉映射器类所在的命名空间,它将自动通过匹配SOAP结果名称与本地类名称来确定映射。

<?php
$resultClassNamespace = '\MyProject\SOAP\Result\\';

改进

我计划根据我的需求添加新功能。如果您需要特殊功能,您有两个选择

  • 自己开发并提交给我一个pull request。我承诺会尽快合并。

  • 创建一个issue并等待我开发。这可能会花费一些时间,因为我通常很忙。