Implementing soap using PHP

Falcon · #1 (**permalink**) 03-03-2008, 02:41 AM

hi buddies

Am new to the soap concept any one please help me to know about that, to implement in my site

Thanks
Falcon

Jeyaseelansarc · #2 (**permalink**) 03-03-2008, 03:16 AM

Hi Falcon,
SOAP is a method of sending and receiving data remotely between a server and client. SOAP is normally transported over the HTTP transport where it is analyzed, executed, and corresponding information returned, back to the client. SOAP libraries exist for every major programming language and performing a SOAP operation is nearly the same easy operation in every language.

Jeyaseelansarc · #3 (**permalink**) 03-03-2008, 03:21 AM

using this we can call any webservices to our sites, But we have to know its wsdl file and the webservice name to call that services

Jeyaseelansarc · #4 (**permalink**) 03-03-2008, 11:51 PM

hi,
can anyone help me to know on w3c?

Falcon · #5 (**permalink**) 03-04-2008, 05:26 AM

Hi Jey

W3C Stands for the World Wide Web Consortium

The most important work done by the W3C is the development of Web specifications (called "Recommendations") that describe communication protocols (like HTML and XML) and other building blocks of the Web.

Regards
Falcon

Falcon · #6 (**permalink**) 03-04-2008, 05:28 AM

Hi Jey

Each W3C Recommendation is developed by a work group consisting of members and invited experts. The group obtains its input from companies and other organizations, and creates a Working Draft and finally a Proposed Recommendation. In general the Recommendation is submitted to the W3C membership and director, for a formal approval as a W3C Recommendation

I think this will help us to know about the W3C

Regards
Falcon

Falcon · #7 (**permalink**) 03-07-2008, 02:37 AM

Hi buddies

WSDL
The service supports a single operation called GetLastTradePrice, which is deployed using the SOAP 1.1 protocol over HTTP. The request takes a ticker symbol of type string, and returns the price as a float.
Example for WSDL

Quote:

<?xml version="1.0"?>
<definitions name="StockQuote"
targetNamespace="http://example.com/stockquote.wsdl"
xmlns:tns="http://example.com/stockquote.wsdl"
xmlns:xsd1="http://example.com/stockquote.xsd"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns="http://schemas.xmlsoap.org/wsdl/">
<types>
<schema targetNamespace="http://example.com/stockquote.xsd"
xmlns="http://www.w3.org/2000/10/XMLSchema">
<element name="TradePriceRequest">
<complexType>
<all>
<element name="tickerSymbol" type="string"/>
</all>
</complexType>
</element>
<element name="TradePrice">
<complexType>
<all>
<element name="price" type="float"/>
</all>
</complexType>
</element>
</schema>
</types>
<message name="GetLastTradePriceInput">
<part name="body" element="xsd1:TradePriceRequest"/>
</message>
<message name="GetLastTradePriceOutput">
<part name="body" element="xsd1:TradePrice"/>
</message>
<portType name="StockQuotePortType">
<operation name="GetLastTradePrice">
<input message="tns:GetLastTradePriceInput"/>
<output message="tns:GetLastTradePriceOutput"/>
</operation>
</portType>
<binding name="StockQuoteSoapBinding" type="tns:StockQuotePortType">
<soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
<operation name="GetLastTradePrice">
<soap

peration soapAction="http://example.com/GetLastTradePrice"/>
<input>
<soap:body use="literal"/>
</input>
<output>
<soap:body use="literal"/>
</output>
</operation>
</binding>
<service name="StockQuoteService">
<documentation>My first service</documentation>
<port name="StockQuotePort" binding="tns:StockQuoteBinding">
<soap:address location="http://example.com/stockquote"/>
</port>
</service>
</definitions>

Regards
Falcon

Falcon · #8 (**permalink**) 03-07-2008, 02:39 AM

Hi buddies

WSDL documents can be assigned an optional name attribute of type NCNAME that serves as a lightweight form of documentation. Optionally, a targetNamespace attribute of type URI may be specified. The URI MUST NOT be a relative URI.

WSDL allows associating a namespace with a document location using an import statement:

<definitions .... >
<import namespace="uri" location="uri"/> *
</definitions>

Regards
Falcon

Falcon · #9 (**permalink**) 03-07-2008, 02:43 AM

Hi Buddies

WSDL is a language for describing the capabilities of Web services. Proposed by IBM and Microsoft, WSDL combines the best of IBM’s NASSL (Network Accessible Services Language) and Microsoft SOAP Contract Language. WSDL is based on XML and is a key part of the UDDI initiative. The WSDL document specification helps improve interoperability between applications, regardless of the protocol or the encoding scheme. The WSDL 1.1 specification defines WSDL as “an XML grammar for describing network services as collections of communication endpoints capable of exchanging messages.”

Essentially, a WSDL document describes how to invoke a service and provides information on the data being exchanged, the sequence of messages for an operation, protocol bindings, and the location of the service. A WSDL document defines services as a collection of endpoints, but separates the abstract definition from the concrete implementation. Messages and port types provide abstract definitions for the data being exchanged and the operations being performed by a service. A binding is provided to map to a concrete set of ports, usually consisting of a URL location and a SOAP binding.

Regards
Falcon

Falcon · #10 (**permalink**) 03-07-2008, 11:13 PM

Hi Buddies

Understanding WSDL
A WSDL definition is an XML document with a root definition element from the http://schemas.xmlsoap.org/wsdl/ namespace. The entire WSDL schema is available at http://schemas.xmlsoap.org/wsdl/ for your reference. The definitions element may contain several other elements including types, message, portType, binding, and service, all of which come from the http://schemas.xmlsoap.org/wsdl/ namespace.

Regards
Falcon

Jeyaseelansarc · #11 (**permalink**) 03-08-2008, 01:29 AM

Hi,
I want to implement it in my page for getting some information from other web service
Can u give any sample in PHP?

Jeyaseelansarc · #12 (**permalink**) 03-10-2008, 11:37 PM

hi,
I have found a sample for implementing soapclient
There should be soap enabled in the server

PHP Code:

  //# - This is used to get google News

$client = new soapclient("http://api.google.com/GoogleSearch.wsdl");

$param=array(

'key'=>'$key',

'q'=>'$search',

'start'=>0,

'maxResults'=>10,

'filter'=>false,

'restrict'=>'yes',

'safeSearch'=>false,

'lr'=>'1ang_en',

'ie'=>'',

'oe'=>''

);

$result =$client->doGoogleSearch($param);//# - This is array after filtered by the params

print_r($result);

Jeyaseelansarc · #13 (**permalink**) 03-10-2008, 11:42 PM

How to create the SOAP server

If your PHP installation supports SOAP, creating a SOAP server in PHP is very simple.(If it does not, try installing php-soap.)

Here's the source code of our demo SOAP server:

PHP Code:

     

   function ItemQuery($itemname)

   {

     srand(crc32($itemname));

     $result = Array('count' => rand(1,500), 'size' => rand(50,200));

     return $result;

   }

   

   $opts = Array();

   $opts['compression'] = SOAP_COMPRESSION_ACCEPT | SOAP_COMPRESSION_GZIP;

   $server = new SoapServer('demo.wsdl', $opts);

   $server->addFunction('ItemQuery');

   $server->handle();

It was placed in demoserver.php in the same directory where the WSDL file is.

Because the URL specified in the WSDL file refers to api, not demoserver.php, we create an URL mapping using an Apache-specific RewriteRule directive.

File .htaccess:

RewriteEngine On
RewriteRule ^api$ demoserver.php

Jeyaseelansarc · #14 (**permalink**) 03-10-2008, 11:43 PM

In the above sample we need to know what wsdl file contains

The WSDL file is an XML file, that consists of five sections:

* types: Basically a list of typedefs for use in parameter and result passing. The types may refer to each others forming tuples, arrays and trees, or to XSD types such as xsd:string and xsd:int.
* messages: The structure of each query and their relevant response. For queries, the parameters are listed. For responses, the return values are listed. The names of the messages are internal to this WSDL file.
* portType: Declares a port by a name, and lists the names of function calls (operations). For each function, it describes which message is used for calling (input) and which message is used for response (output).
* binding: It describes the method of passing the input and output for each operation. Typically, they are encoded in SOAP encoding, but they can also be passed raw.
* service: For each port declared in portType, it describes the endpoint (address) through which the query is performed.

Jeyaseelansarc · #15 (**permalink**) 03-10-2008, 11:47 PM

hi,
i hope you can get more information to work on soap with AJAX and PHP in the following link

How to write and use SOAP services in PHP and AJAX

It can help us to create and use soap server in our webserver.

Jeyaseelansarc · #16 (**permalink**) 03-10-2008, 11:50 PM

To learn more on WSDL

Go WSDL Tutorial

This is really useful documents

Jeyaseelansarc · #17 (**permalink**) 03-10-2008, 11:56 PM

As i have learned SOAP is a wonderful technology that can help you in developing great applications.

Unless you have been living in a cave somewhere without Internet access for the last few years, you have undoubtedly heard of XML, SOAP and Multi-Tiered Application Programming.

XML and SOAP, and in turn Multi-Tiered Programming, are technologies that can take you from being a run of the mill code hacker to a professional application developer that actually builds cool things that work and which other people can work on. These technologies enable you to build applications that separate data from presentation, keep things organized and enable your application to scale as your needs and user base increases.

If you believe like I do that the Internet is the ultimate building ground of our future, then you have to see that the 'hackish' method in which most applications for the web are built and designed is pitiful.

You may be asking, how can XML and SOAP help me to avoid poor application design? Well, by themselves they won't help at all. First and foremost you must get yourself into the mind set that it needs to take place. XML and SOAP are just two tools that will allow you to accomplish your goal.

Today we will build a Web Service using SOAP. In doing so, I hope that you will become familiar with the technology so that you can start incorporating it into your future applications.

Jeyaseelansarc · #18 (**permalink**) 03-11-2008, 03:32 AM

here basic terminology regarding soap implementation

# XML: "XML is the Extensible Markup Language. It is designed to improve the functionality of the Web by providing more flexible and adaptable information identification." (The XML FAQ other words, XML is a method for describing your data. For the purpose of this tutorial, we will not be directly manipulating any XML. Instead, we will examine the XML resulting from our scripts. The libraries and protocols we will use through this tutorial will handle the XML manipulation for us.%br%%br%

# SOAP: Simple Object Access Protocol. "SOAP is a lightweight protocol for exchange of information in a decentralized, distributed environment. It is an XML based protocol that consists of three parts: an envelope that defines a framework for describing what is in a message and how to process it, a set of encoding rules for expressing instances of application-defined datatypes, and a convention for representing remote procedure calls and responses." (http://www.w3.org/TR/2000/NOTE-SOAP-.../)%br%%br%SOAP is what you are here for. We will develop both a client and a server for our SOAP service. In this tutorial, we will be using the NuSOAP library. (http://dietrich.ganx4.com/nusoap/index.php)%br%%br%

# WSDL: "WSDL is an XML format for describing network services as a set of endpoints operating on messages containing either document-oriented or procedure-oriented information." (http://www.w3.org/TR/wsdl)%br%%br%As with XML, we will not be directly any WSDL documents. The wonderful NuSOAP library will generate WSDL documents for us. What you need to know about WSDL is that it is a document that describes a Web Service. It can tell a client how to interact with the Web Service and what interfaces that Web Service provides.%br%%br%

# Client: We will define a Client as a script that uses a Web Service.%br%%br%

# Server: Conversely, a Server will be defined as a script that provides a Web Service.

Falcon · #19 (**permalink**) 03-12-2008, 02:18 AM

Hi Buddies,

Here is one example for soap implementation with NuSoap class.

Quote:

<?php
require_once('nusoap.php');

/* Initialize parameter */

$paramRQ = array('x' => '12', 'y' => '13');

/* create client for my rpc web service */
$wsdl = "http://www.pascalbotte.be/rcx-ws-rpc/rcx?WSDL";
$client = new soapclient($wsdl, true);

// Error check
$err = $client->getError();
if ($err) {
// Show error
echo '<h2>Error with soapclient creation: </h2><pre>' . $err . '</pre>';
// call won't work
}

/* create proxy object */
$proxy = $client->getProxy();

/* call queryRcx */
$result = $proxy->queryRcx($paramRQ);

/* faults during call */
if($client->fault) {
echo "FAULT: <p>code: {$proxy->faultcode}<br />";
echo "String: {$proxy->faultstring}<br />";
echo '<pre>' . htmlspecialchars($proxy->request, ENT_QUOTES) . '</pre>';
echo '<pre>' . htmlspecialchars($proxy->response, ENT_QUOTES) . '</pre>';
}
else {
echo '<h2>Request</h2>';
echo '<pre>' . htmlspecialchars($proxy->request, ENT_QUOTES) . '</pre>';
echo '<h2>Response</h2>';
echo '<pre>' . htmlspecialchars($proxy->response, ENT_QUOTES) . '</pre>';

print_r($result);
}
?>

Regards
Falcon

Falcon · #20 (**permalink**) 03-12-2008, 02:26 AM

Hi Buddies

Example for Google search using soap with NuSoap class

Quote:

<?php

require_once 'SOAP/nusoap.php';
$key = 'Enter your Google APIs key here';
$wsdl = new SOAP_WSDL('GoogleSearch.wsdl');
$googleProxy = $wsdl->getProxy();
echo $googleProxy->doSpellingSuggestion($key, 'diktionary');

?>

Regards
Falcon