在 PHP 中使用 SoapClient 的示例

Habdul Hazeez 2023年1月30日 2022年7月18日
  1. 从 PHP 中的 Web 服务获取函数和类型
  2. PHP SOAP 示例 1:温度转换
  3. PHP SOAP 示例 2:打个招呼
  4. PHP SOAP 示例 3:简单算术
  5. PHP SOAP 示例 4:国家信息
  6. PHP SOAP 示例 5:使用 NuSOAP 进行温度转换
  7. 额外示例:使用 cURL 的 SOAP 调用
在 PHP 中使用 SoapClient 的示例

本文介绍了使用 PHP SoapClient 处理 WSDL 文件的六个示例。在此之前,我们将解释如何从 Web 服务中获取函数和类型。

如果你想使用 Web 服务,这是必须的。

从 PHP 中的 Web 服务获取函数和类型

在使用 Web 服务之前,你必须做的第一件事是了解它的功能和类型。那是因为服务函数将从服务返回数据。

类型是你可能提供给函数的参数的数据类型。我们说可能是因为,稍后你会发现,并非所有服务函数都需要参数。

在 PHP 中,你可以使用以下内容从服务中获取函数和类型。将服务 URL 替换为另一个,PHP 将返回函数的名称和类型。

你应该连接到互联网才能使代码正常工作。

<?php
    $client = new SoapClient("http://www.dneonline.com/calculator.asmx?WSDL");
    echo "<b>The functions are:</b> <br/>";
    echo "<pre>";
    var_dump($client->__getFunctions());
    echo "</pre>";

    echo "<b>The types are:</b> <br />";
    echo "<pre>";
    var_dump($client->__getTypes());
    echo "</pre>";
?>

输出(以下是摘录):

<b>The functions are:</b> <br/><pre>array(8) {
  [0]=>
  string(32) "AddResponse Add(Add $parameters)"
  [1]=>
  string(47) "SubtractResponse Subtract(Subtract $parameters)"
  [2]=>
  string(47) "MultiplyResponse Multiply(Multiply $parameters)"
  [3]=>
  string(41) "DivideResponse Divide(Divide $parameters)"
  [4]=>
  string(32) "AddResponse Add(Add $parameters)"
  [5]=>
  string(47) "SubtractResponse Subtract(Subtract $parameters)"
  [6]=>
  string(47) "MultiplyResponse Multiply(Multiply $parameters)"
  [7]=>
  string(41) "DivideResponse Divide(Divide $parameters)"
}
</pre><b>The types are:</b> <br /><pre>array(8) {
  [0]=>
  string(36) "struct Add {
 int intA;
 int intB;
}"
  [1]=>
  string(38) "struct AddResponse {
 int AddResult;
}"
  [2]=>
  string(41) "struct Subtract {
 int intA;
 int intB;
}"
..........

笔记:

  1. types 下,你将找到为函数定义的参数的数据类型。
  2. 在代码中为函数提供参数时,数据类型必须相同。
  3. 如果你在类型定义中看到类似 int intA 的内容,则参数必须是名为 intA 的整数。

现在你知道如何获取服务功能和类型,你可以开始使用服务了。

PHP SOAP 示例 1:温度转换

W3schools 提供了一个温度转换器 WSDL 文件。在 PHP 中,你可以连接到此文件以执行温度转换。

为此(以及使用 SoapClient 的其他 SOAP 操作)采取的步骤如下:

  • 创建一个新的 SoapClient 对象。
  • 定义你要使用的数据。此数据应采用服务功能可以使用的格式。
  • 调用服务的函数。
  • 显示结果。

我们在下面的代码中实现了这些步骤。

<?php
    // Create the client object and pass in the
    // URL of the SOAP server.
    $soap_client = new SoapClient('https://www.w3schools.com/xml/tempconvert.asmx?WSDL');
    // Create an associative array of the data
    // that you'll pass into one of the functions
    // of the client.
    $degrees_in_celsius = array('Celsius' => '25');
    // Use a function of the client for the
    // conversion.
    $convert_to_fahrenheit = $soap_client->CelsiusToFahrenheit($degrees_in_celsius);
    // Show the result using var_dump. Other PHP
    // functions like echo will not work.
    echo "<pre>";
    var_dump($convert_to_fahrenheit);
    echo "</pre>";
    // Repeat the same process. This time, use the
    // FahrenheitToCelsius function to convert a
    // temperature from Fahrenheit to Celsius.
    $degrees_in_fahrenheit = array('Fahrenheit' => '25');
    $convert_to_celsius = $soap_client->FahrenheitToCelsius($degrees_in_fahrenheit);
    echo "<pre>";
    var_dump($convert_to_celsius);
    echo "</pre>";
?>

输出:

<pre>object(stdClass)#2 (1) {
  ["CelsiusToFahrenheitResult"]=>
  string(2) "77"
}
</pre><pre>object(stdClass)#3 (1) {
  ["FahrenheitToCelsiusResult"]=>
  string(17) "-3.88888888888889"
}
</pre>

PHP SOAP 示例 2:打个招呼

我们的第二个示例是使用 learnwebservices.com打招呼消息。你所要做的就是使用 SoapClient 启动对服务的 SOAP 调用。

之后,调用它的 SayHello 方法并传入你想要的名称。然后你可以访问 Message 方法来显示消息。

消息应该是 Hello your_desired_name!。例如,如果 your_desired_nameMartinez,你将获得 Hello Martinez! 的输出。

这就是我们在下一个代码中所做的。

<?php
    $soap_client = new SoapClient('https://apps.learnwebservices.com/services/hello?wsdl');
    // Call a function of the soap client.
    $say_hello = $soap_client->SayHello(['Name' => 'Martinez']);
    // Print the message from the client.
    echo $say_hello->Message;
?>

输出:

Hello Martinez!

PHP SOAP 示例 3:简单算术

在这个例子中,我们使用一个允许你执行简单算术的 Web 服务。这种算术包括加法、除法、乘法和减法。

但是,我们只会展示如何使用服务进行添加和分割。你应该尝试其余的,因为它会让你更好地了解服务。

此服务的算术功能要求数字有名称。这些名称是 intAintB,因此我们将这些名称分配给关联数组中的数字以方便使用。

之后,我们将此数组传递给服务的 AddDivide 函数。下面的代码显示了所有这些在行动和计算结果。

<?php
    // Connect to a SOAP client that allows you
    // to do basic calculations.
    $soap_client = new SoapClient("http://www.dneonline.com/calculator.asmx?WSDL");
    // Define data that'll use with the client. This
    // time the client requires that arguments that
    // you'll pass in has the name intA and intB.
    // Therefore, we use that name in our array.
    $numbers_for_the_client = array("intA" => 222, "intB" => 110);
    $add_the_numbers = $soap_client->Add($numbers_for_the_client);
    $divide_the_numbers = $soap_client->Divide($numbers_for_the_client);
    // Show the results of the addition and
    // division of numbers.
    echo "<pre>";
    var_dump($add_the_numbers);
    var_dump($divide_the_numbers);
    echo  "</pre>";
?>

输出:

<pre>object(stdClass)#2 (1) {
  ["AddResult"]=>
  int(332)
}
object(stdClass)#3 (1) {
  ["DivideResult"]=>
  int(2)
}
</pre>

PHP SOAP 示例 4:国家信息

如果你想获取有关某个国家/地区的某些详细信息,此示例中的服务适合你。该服务有许多功能可以返回一个国家的详细信息。

其中一些函数是 ListOfCountryNameByCodesListOfContinentsByName。下面,我们使用 ListOfCountryNameByCodes 打印世界上的国家。

<?php
    // A soap client that allows you to view information
    // about countries in the world
    $soap_client = new SoapClient("http://webservices.oorsprong.org/websamples.countryinfo/CountryInfoService.wso?WSDL");
    // Use a client function to print country names.
    $list_countries_names_by_code = $soap_client->ListOfCountryNamesByCode();
    /*
    Here is another function you can try out.
    $list_of_continents_by_name = $client->ListOfContinentsByName();
    */
    // Show the results.
    echo "<pre>";
    var_dump($list_countries_names_by_code);
    echo  "</pre>";
?>

输出(以下是摘录):

<pre>object(stdClass)#2 (1) {
  ["ListOfCountryNamesByCodeResult"]=>
  object(stdClass)#3 (1) {
    ["tCountryCodeAndName"]=>
    array(246) {
      [0]=>
      object(stdClass)#4 (2) {
        ["sISOCode"]=>
        string(2) "AD"
        ["sName"]=>
        string(7) "Andorra"
      }
      [1]=>
      object(stdClass)#5 (2) {
        ["sISOCode"]=>
        string(2) "AE"
        ["sName"]=>
        string(20) "United Arab Emirates"
      }
      [2]=>
      object(stdClass)#6 (2) {
        ["sISOCode"]=>
        string(2) "AF"
        ["sName"]=>
        string(11) "Afghanistan"
      }
 ....

PHP SOAP 示例 5:使用 NuSOAP 进行温度转换

NuSOAP 是一个 PHP 工具,它允许你将 SOAP 连接到 Web 服务。操作模式类似于使用 SoapClient,但有以下区别。

  1. nusoap_client 需要服务地址和 wsdl 作为其参数。
  2. 你将处理的数据必须是 XML。

要使用 NuSOAP,请从 SourceForge 下载它并将其放到你当前的工作目录中。然后使用以下代码进行温度转换。

你将观察到步骤是相同的​​,除了前面详述的例外。还有一件事,代码在 PHP5 中工作,它在 PHP8 中返回 bool

<?php
    // This PHP script use NUSOAP for SOAP connection
    // and it works in PHP5 ONLY.
    require_once('nusoap.php');
    // Specify the WSDL file and initiate a new
    // NUSOAP client.
    $wsdl   = "https://www.w3schools.com/xml/tempconvert.asmx?WSDL";
    $nusoap_client = new nusoap_client($wsdl, 'wsdl');
    // Call on the required method of the client.
    $function_from_client = "CelsiusToFahrenheit";
    // We'll save the result of the entire operation
    // in an array.
    $result = array();
    // Temperature for conversion.
    $temperature = 86;
    // Specify the temperature as an XML file
    $temperature_as_xml= '<CelsiusToFahrenheit xmlns="https://www.w3schools.com/xml/">
                <Celsius>' . $temperature . '</Celsius>
            </CelsiusToFahrenheit>';
    // If the function exists in the client, initiate
    // the conversion.
    if (isset($function_from_client)) {
        $result['response'] = $nusoap_client->call($function_from_client, $temperature_as_xml);
    }
    // Show the results
    echo "<pre>" . $temperature . ' Celsius => ' . $result['response']['CelsiusToFahrenheitResult'] . ' Fahrenheit' . "</pre>";
?>

输出:

<pre>86 Celsius => 186.8 Fahrenheit</pre>

额外示例:使用 cURL 的 SOAP 调用

你可以使用 cURL 对 Web 服务进行 SOAP 调用。我们将再次使用 W3Schools 温度转换服务。

同时,使用 cURL,你必须在使用服务时执行以下操作。

  1. 数据应该在 Soap Envelope 中。
  2. 你必须将内容标头发送到浏览器。
  3. 你必须定义 cURL 连接选项。

我们在下面的代码中完成了所有这些以及更多工作;代码注释详细说明了每一步发生了什么。

<?php
    // This script allows you to use w3schools
    // convert via curl.
    $webservice_address = "https://www.w3schools.com/xml/tempconvert.asmx";
    // The number you'll like to convert, in this case
    // we'll like to convert a temperature in celsius
    // fahrenheit.
    $temperature = 56;
    // Pass the temperature as an XML file.
    // The XML format is based on the official
    // format for the SOAP client by w3schools.
    // You can find more at:
    $temperature_as_xml = '<?xml version="1.0" encoding="utf-8"?>
    <soap12:Envelope
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
        xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
      <soap12:Body>
        <CelsiusToFahrenheit xmlns="https://www.w3schools.com/xml/">
          <Celsius>' . $temperature . '</Celsius>
        </CelsiusToFahrenheit>
      </soap12:Body>
    </soap12:Envelope>';
    // Define content headers
    $content_headers = array(
        'Content-Type: text/xml; charset=utf-8',
        'Content-Length: '.strlen($temperature_as_xml)
    );
    // Initiate the CURL connection and define
    // the connection options.
    $init_curl_connection = curl_init($webservice_address);
    curl_setopt($init_curl_connection, CURLOPT_POST, true);
    curl_setopt($init_curl_connection, CURLOPT_HTTPHEADER, $content_headers);
    curl_setopt($init_curl_connection, CURLOPT_POSTFIELDS, $temperature_as_xml);
    curl_setopt($init_curl_connection, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($init_curl_connection, CURLOPT_SSL_VERIFYHOST, false);
    curl_setopt($init_curl_connection, CURLOPT_SSL_VERIFYPEER, false);
    // Use the curl_exec function to get the
    // received data.
    $recieved_data = curl_exec($init_curl_connection);
    // Save the connection result in another variable.
    // This will allow us to use it in an "if" statement
    // without causing ambiguity.
    $connection_result = $recieved_data;
    // Check if there is an error.
    if ($connection_result === FALSE) {
        printf("CURL error (#%d): %s<br>\n", curl_errno($init_curl_connection),
        htmlspecialchars(curl_error($init_curl_connection)));
    }
    // Close the CURL connection
    curl_close ($init_curl_connection);
    // Show the received data.
    echo $temperature . ' Celsius => ' . $recieved_data . ' Fahrenheit';
?>

输出(在浏览器中):

56 Celsius => 132.8 Fahrenheit

输出(详细版本):

Celsius => <?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<CelsiusToFahrenheitResponse xmlns="https://www.w3schools.com/xml/">
<CelsiusToFahrenheitResult>132.8</CelsiusToFahrenheitResult>
</CelsiusToFahrenheitResponse><
/soap:Body></soap:Envelope>Fahrenheit
Habdul Hazeez avatar Habdul Hazeez avatar

Habdul Hazeez is a technical writer with amazing research skills. He can connect the dots, and make sense of data that are scattered across different media.

LinkedIn