How to use soap class in php (with example).

This post will show a simple example of how to interpret a WSDL file and a very simple, yet quick example of how to extract information from this file through PHP. Before this post try in your host please check the php info to see your host soap is enable or not.

Code Structure:

<?
 
$a['username'] = "*****";  /*Your  Username*/
$a['password'] = "*****";  /*Your  Password*/
$a['key'] = 	 "*****"; /*Your api key.*/

$soap_url='http://api.example.com/user/client.wsdl'; //wsdl file location url
$soap = new SoapClient($soap_url);

$response=$soap->sendSMS( array ("gmaeName" => $a) );  //gameName is a element name
 
echo '<pre>';
print_r($response); //output the respones
echo '</pre>
';

?>

Work example:

WSDL file: For the example WSDL file we'll take this WSDL file. It's about the World Championship football.

Let's try and print the top goal scorers of the tournament. For doing this, we can see the following on line 1116-1120 as like

  
    <operation name="TopGoalScorers">
      <documentation>Returns an array with the top N goal scorers and their current score. Pass 0 as TopN and you get them all.</documentation>
      <input message="tns:TopGoalScorersSoapRequest"/>
      <output message="tns:TopGoalScorersSoapResponse"/>
    </operation>

We now see that the operation we should call is called TopGoalScorers. This operation expects as input a TopGoalScorersSoapRequest. We don't know what it is yet, so let's find out. If we search the document for this message, we get to line 868-870 as like

 
  <message name="TopGoalScorersSoapRequest">
    <part name="parameters" element="tns:TopGoalScorers"/>
  </message>

Right. So now we know that the TopGoalScorersSoapRequest consists of just one part (the parameters). We know that the element is called TopGoalScorers, but we do not know anything about this parameter yet. So we search the document for the element TopGoalScorers. We can find this element at line 360-366 as like

 
      <xs:element name="TopGoalScorers">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="iTopN" type="xs:int"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

Now there we have it: we now finally know that the method TopGoalScorers which we saw in the first WSDL fragment expects one parameter as input. This parameter is called iTopN and is of the type int.

Getting to the code:
Finally we can do something with the WSDL. Actually we can do this in a very short way thanks to the PHP SoapClient!

Calling the service with the parameter and obtaining the results can be done in just 2 lines of code. Let's give it a try and obtain the top 5 goal scorers. We can do this by the following two lines:

1. $client = new SoapClient("http://footballpool.dataaccess.eu/data/info.wso?wsdl");
2. $result = $client->TopGoalScorers(array('iTopN'=>5));

Note that we use the information we obtained from the WSDL file here: on the $client object, we call the method TopGoalScorers and provide an array of parameters. In this case the array contains only one parameter: the iTopN parameter with an int value of 5. The result will contain an object, so you will need to traverse the object structure.

Complete Code:

<?php

if ($_POST['topn'] > 0 && (int) $_POST['topn'] <= 20){
  $topn = (int) $_POST['topn'];
  $client = new SoapClient("http://footballpool.dataaccess.eu/data/info.wso?wsdl");
  $result = $client->TopGoalScorers(array('iTopN' => $topn));
  // Note that $array contains the result of the traversed object structure
  $array = $result->TopGoalScorersResult->tTopGoalScorer;

  print "
    <table border='2'>
<tr>
        <th>Rank</th>
        <th>Name</th>
        <th>Goals</th>
      </tr>
";
  
  foreach($array as $k=>$v){
    print "
<tr>
        <td align='right'>" . ($k+1) . "</td>
          <td>" . $v->sName . "</td>
          <td align='right'>" . $v->iGoals . "</td>
        </tr>
";
  }
  
  print "</table>
";
}
else {

?>

  <form id="topscorers" action="index.php" method="post">
    Topscorers list be? (Between 1 and 20).
    <input id="topn" name="topn" size="2" type="text" value="10" />
    <input id="submit" name="submit" type="submit" value="submit" />
  </form>
<?php

}

?>

To know about how to make api go to here.

How to use soap class in php (with example).

Thursday, May 16, 2013