PHP: SOAP Functions - Manual

downloads | documentation | faq | getting help | mailing lists | reporting bugs | php.net sites | links | conferences | my php.net

search for in the

is_soap_fault snmpwalkoid

Last updated: Fri, 26 Jan 2007

view this page in

# CL. SOAP Functions

# Введение

The SOAP extension can be used to write SOAP Servers and Clients. It supports subsets of SOAP 1.1, SOAP 1.2 and WSDL 1.1 specifications.

# Требования

This extension makes use of the GNOME xml library. Download and install this library. You will need at least libxml-2.5.4.

# Установка

This extension is only available if PHP was configured with `--enable-soap`.

# Настройка во время выполнения

Поведение этих функций зависит от установок в `php.ini`.

Таблица 1. SOAP Configuration Options

Name | Default | Changeable | Changelog
--- | --- | --- | ---
soap.wsdl_cache_enabled | "1" | PHP_INI_ALL | Available since PHP 5.0.0.
soap.wsdl_cache_dir | "/tmp" | PHP_INI_ALL | Available since PHP 5.0.0.
soap.wsdl_cache_ttl | "86400" | PHP_INI_ALL | Available since PHP 5.0.0.

Для подробного описания констант PHP_INI_*, обратитесь к документации функции ini_set().

Краткое разъяснение конфигурационных директив.

`soap.wsdl_cache_enabled` boolean

  Enables or disables the WSDL caching feature.

`soap.wsdl_cache_dir` string

  Sets the directory name where the SOAP extension will put cache files.

`soap.wsdl_cache_ttl` int

  Sets the number of seconds (time to live) that cached files will be used instead the originals.

# Предопределенные классы

## SoapClient

### Конструктор

- SoapClient->__construct() - constructs a new SoapClient object

### Методы

- SoapClient->__call() - Calls a SOAP function (deprecated)

- SoapClient->__doRequest() - Performs a SOAP request

- SoapClient->__getFunctions() - Returns list of SOAP functions

- SoapClient->__getLastRequest() - Returns last SOAP request

- SoapClient->__getLastRequestHeaders() - Returns last SOAP request headers

- SoapClient->__getLastResponse() - Returns last SOAP response

- SoapClient->__getLastResponseHeaders() - Returns last SOAP response headers

- SoapClient->__getTypes() - Returns list of SOAP types

- SoapClient->__setCookie() - Sets the cookie that will be sent with the SOAP request

- SoapClient->__soapCall() - Calls a SOAP function

## SoapFault

### Конструктор

- SoapFault->__construct() - construct a new SoapFault object

## SoapHeader

SoapHeader is a special low-level class for passing or returning SOAP headers. It's just a data holder and it does not have any special methods except its constructor. It can be used in the SoapClient->__soapCall() method to pass a SOAP header or in a SOAP header handler to return the header in a SOAP response.

### Конструктор

- SoapHeader->__construct() - construct a new SoapHeader object

## SoapParam

SoapParam is a special low-level class for naming parameters and returning values in `non-WSDL` mode. It's just a data holder and it does not have any special methods except its constructor.

### Конструктор

- SoapParam->__construct() - construct a new SoapParam object

## SoapServer

### Конструктор

- SoapServer->__construct() - construct a new SoapServer object

### Методы

- SoapServer->addFunction() - Adds one or several functions those will handle SOAP requests

- SoapServer->fault() -

- SoapServer->getFunctions() - Returns list of defined functions

- SoapServer->handle() - Handles a SOAP request

- SoapServer->setClass() - Sets class which will handle SOAP requests

- SoapServer->setPersistence() - Sets persistence mode of SoapServer

## SoapVar

SoapVar is a special low-level class for encoding parameters and returning values in `non-WSDL` mode. It's just a data holder and does not have any special methods except the constructor. It's useful when you want to set the type property in SOAP request or response.

### Конструктор

- SoapVar->__construct() - construct a new SoapVar object

# Предопределенные константы

Перечисленные ниже константы определены данным расширением и могут быть доступны только в том случае, если PHP был собран с поддержкой этого расширения или же в том случае, если данное расширение подгружается во время выполнения.

`SOAP_1_1` (integer)

`SOAP_1_2` (integer)

`SOAP_PERSISTENCE_SESSION` (integer)

`SOAP_PERSISTENCE_REQUEST` (integer)

`SOAP_FUNCTIONS_ALL` (integer)

`SOAP_ENCODED` (integer)

`SOAP_LITERAL` (integer)

`SOAP_RPC` (integer)

`SOAP_DOCUMENT` (integer)

`SOAP_ACTOR_NEXT` (integer)

`SOAP_ACTOR_NONE` (integer)

`SOAP_ACTOR_UNLIMATERECEIVER` (integer)

`SOAP_COMPRESSION_ACCEPT` (integer)

`SOAP_COMPRESSION_GZIP` (integer)

`SOAP_COMPRESSION_DEFLATE` (integer)

`UNKNOWN_TYPE` (integer)

`XSD_STRING` (integer)

`XSD_BOOLEAN` (integer)

`XSD_DECIMAL` (integer)

`XSD_FLOAT` (integer)

`XSD_DOUBLE` (integer)

`XSD_DURATION` (integer)

`XSD_DATETIME` (integer)

`XSD_TIME` (integer)

`XSD_DATE` (integer)

`XSD_GYEARMONTH` (integer)

`XSD_GYEAR` (integer)

`XSD_GMONTHDAY` (integer)

`XSD_GDAY` (integer)

`XSD_GMONTH` (integer)

`XSD_HEXBINARY` (integer)

`XSD_BASE64BINARY` (integer)

`XSD_ANYURI` (integer)

`XSD_ANYXML` (integer)

  Added in PHP 5.1.0.

`XSD_QNAME` (integer)

`XSD_NOTATION` (integer)

`XSD_NORMALIZEDSTRING` (integer)

`XSD_TOKEN` (integer)

`XSD_LANGUAGE` (integer)

`XSD_NMTOKEN` (integer)

`XSD_NAME` (integer)

`XSD_NCNAME` (integer)

`XSD_ID` (integer)

`XSD_IDREF` (integer)

`XSD_IDREFS` (integer)

`XSD_ENTITY` (integer)

`XSD_ENTITIES` (integer)

`XSD_INTEGER` (integer)

`XSD_NONPOSITIVEINTEGER` (integer)

`XSD_NEGATIVEINTEGER` (integer)

`XSD_LONG` (integer)

`XSD_INT` (integer)

`XSD_SHORT` (integer)

`XSD_BYTE` (integer)

`XSD_NONNEGATIVEINTEGER` (integer)

`XSD_UNSIGNEDLONG` (integer)

`XSD_UNSIGNEDINT` (integer)

`XSD_UNSIGNEDSHORT` (integer)

`XSD_UNSIGNEDBYTE` (integer)

`XSD_POSITIVEINTEGER` (integer)

`XSD_NMTOKENS` (integer)

`XSD_ANYTYPE` (integer)

`SOAP_ENC_OBJECT` (integer)

`SOAP_ENC_ARRAY` (integer)

`XSD_1999_TIMEINSTANT` (integer)

`XSD_NAMESPACE` (string)

`XSD_1999_NAMESPACE` (string)

add a note User Contributed Notes
SOAP Functions
kroesjnov at hotmail dot com
09-Feb-2007 07:38
`If you dont want to manually maintain the classmap, make sure you use the same names for your PHP object classes and your WSDL complexTypes, and use the following code:
$classmap = array();
$tmpClient = new SoapClient("soapserver.wsdl");
foreach($tmpClient->__getTypes() as $type)
{
$array = split(" ", $type);
if($array[0] == "struct" && class_exists($array[1]))
{
$classmap[$array[1]] = $array[1];
}
}
unset($tmpClient);
$server = new SoapServer("soapserver.wsdl", array("classmap" => $classmap));
unset($classmap);
$server->setClass("someclass");
$server->handle();`
Herman Hiddema
07-Feb-2007 06:32
`I recently found that when using SoapClient with client certificates (the 'local_cert' and 'passphrase' options), PHP needs to have CURL enabled. (At least with PHP 5 and Apache on Windows)
I kept getting errors like this:
Unable to set local cert chain file `filename.pem'; Check that your cafile/capath settings include details of your certificate and its issuer in somescript.php on line ##
I tried everything I could find on the net (correct .pem format, constructing and passing my own stream context, etc) but nothing would work. Enabling CURL (by uncommenting extension=php_curl.dll in php.ini) instantly caused my client to work.`
brephophagist
18-Jan-2007 09:45
`For those working from a wsdl full of complex types that just want a class structure to hang your code on and not worry about typing in long parameter lists (or creating a script to do so): wsdl2php is a wonderful time-saver. Gets a structure going so you can go in and add what validation and special data munging you need: http://www.urdalen.no/wsdl2php/
Big up yourself, Knut.`
Olaf Krische
21-Nov-2006 01:48
`If you use SSL with a cert and password authentication:
$wsdl = "https://ws.ecopatz.de/ProductInfo?wsdl";
$pass = 'a password';
$certFile = "./mycert.pem";
$client = new SoapClient($wsdl,
array(
'local_cert' => $certFile,
'passphrase' => $pass
)
);
If you have problems with the certfile like this:
Warning: SoapClient::__construct(): Unable to set local cert chain file `./mycert.pem'; Check that your cafile/capath settings include details of your certificate and its issuer in productinfo.php on line 27
then the certFile is probably in the "wrong format" (the wrong format for php maybe). It worked for me, when i appended the content of the private key file and the certificate file to a single file "mycert.pem":
cat mycert.key >mycert.pem # mycert.key was the private key
cat mycert.crt >>mycert.pem # mycert.crt was the signed certificate
Thanks to an author somewhere, who pointed to "curl --cert", where this little "so unimportant" dependency has been mentioned.`
Gerôme <kontakt at bmservices dot de>
16-Nov-2006 08:27
`When compiling SOAP support for PHP 5.2.0 it was not sufficient to use "--with-soap" in the "./configure" statement. I also had to include "--enable-soap" to get it work.`
nico
25-Aug-2006 06:20
`If you want to build a Soap Server for Microsoft Office's client (like Microsoft Office Research Service) you need to rewrite SOAP's namespaces :
<?php
// (...)
$server = new SoapServer($wsdl, array('uri' => $uri, 'classmap' => $classmap));
$server->setClass($class);
function callback($buffer)
{
$s = array('<ns1:RegistrationResponse>', 'ns1:', 'xmlns:ns1="urn:Microsoft.Search"');
$r = array('<RegistrationResponse xmlns="urn:Microsoft.Search">', '', '');
return (str_replace($s, $r, $buffer));
}
ob_start('callback');
$server->handle();
ob_end_flush();
// (...)
?>
There are a complete example at this URL : http://touv.ouvaton.org/article.php3?id_article=104`
info at webability dot info
22-Aug-2006 12:30
`If you want to use soap over https, you *must* compile php with the configure option with-openssl or you will have the error "[HTTP] SSL support not available in this build" while trying to use the web services over SSL`
mini at freebsd dot org
08-Jul-2006 04:54
`wokan at cox dot net is incorrect about the security of URI-passed values to HTTPS URIs. HTTPS connections are HTTP inside SSL -- all of the HTTP traffic, including the request, are encrypted.`
lists at 5etdemi dot com
13-Mar-2006 06:26
`To enable SoapClient on Windows, simply add a line:
extension=php_soap.dll
in php.ini in the extensions section.`
adm
01-Mar-2006 11:27
`Wondering why the function you just added to your WSDL file is not available to your SOAP client? Turn off WSDL caching, which (as the documentation says) is on by default.
At the top of your script, use:
$ini = ini_set("soap.wsdl_cache_enabled","0");`
Matthew Glubb
20-Jan-2006 08:05
`For anyone wondering why they are getting a "DTD are not supported by SOAP" fault string. It is because you are probably being returned an HTML page due to an internal server error, 404, etc.
Refer to the documentation for SoapClient->__getLastResponse in order to see what returned by the server.`
ckl at ecw dot de
16-Jan-2006 11:54
`To debug a SOAP service using SoapServer(), a WSDL file and Zend Studio Client/Server, you have to append ?start_debug=1&amp;debug_port=10000 to the service location:
--- snip ---
... method / service definition ....
<service name="SOAPService">
<port
name="SOAPServicePort"
binding="typens:SOAPServiceBinding">
<soap:address
location="$URL?start_debug=1&amp;debug_port=10000"/>
</port>
</service>
--- snap ---`
Rui Martins
18-Dec-2005 08:33
`Here's an example on how to pass ArrayOfAnyType arguments
containing complex types.
Suppose your WSDL file defines "http://any.url.com/" as the default namespace and a complex type "SomeComplexType".
If you want to call a WebServices which takes an ArrayOfAnyType argument of "SomeComplexType"s you need to perform the following:
<?php
// complexTypes being an array containing several instances of SomeComplexType
myWSParameter = array();
foreach (complexTypes as ct)
{
// Don't misspell the type or the namespace. Also note that php won't assume the default namespace defined in the WSDL file.
myWSParameter []= new SoapVar(ct, 0, "SomeComplexType", "http://any.url.com/");
}
?>
On the other hand, when a WebService returns an ArrayOfAnyType you have to do the following to access each of its elements.
<?php
// Here, we will be echoing each return item
$res = $someWS->myFunction($myArgs)
// If only one element is returned, an array won't be built
if (is_array(myFunctionResult->anyType))
{
foreach (myFunctionResult->anyType as $soapVar)
{
echo $soapVar->enc_value;
}
}
else
{
echo myFunctionResult->anyType->enc_value;
}
?>
This has all been tested using a .NET WebService.`
ChrisB
23-Oct-2005 11:03
`Heads up for anyone using PHP Soap + Sessions + PEAR DB classes.
Every time you make a call, via the soap client to your web service, your PEAR DB session is put to sleep and it doesnt by default wake upon the next request.
To fix this I simply called my particular database close call ifx_close() below my $soap->handle();`
Bob
11-Oct-2005 01:17
`If you are scratching your head why NuSOAP not working on PHP 5.x , the reason is this built-in SOAP Extenstion uses same soapclient() class name as Nusoap.
replace 'soapclient' with 'soapclient_xxx' in nusoap.php and you are good to go...`
john
29-Sep-2005 09:32
`Those having to work with Paypal's api and using PHP5 SOAP:
http://www.johnjawed.com/ppo/`
johnjawed at gmail dot com
22-Sep-2005 09:29
`For those wondering on how to set attributes on nodes with PHP5 SOAP, it would be done as such:
<... soap env/header>
<foo bar="blah">12345</foo>
array("foo" => array("_" => 12345, "bar" => "blah"));`
Darryl
20-Jul-2005 11:46
`Having trouble passing complex types over SOAP using a PHP SoapServer in WSDL mode? Not getting decoded properly? This may be the solution you're looking for!
When using ComplexType in the schema portion of the WSDL file, You need use an additional step to tell PHP SOAP how to encode the objects. The first method would be to explicitely encapsulate the object in a SoapVar object - telling PHP to use generalized SOAP encoding rules (which encodes all ComplexTypes as Structs). This won't work, though, if the client is expecting the objects to be encoded according to the WSDL's schema. So, The actual way to do this is:
* First, define a specific PHP class which is actually just a data structure holding the various properties, and the appropriate ComplexType in the WSDL.
<?php
class MyComplexDataType {
public $myProperty1;
public $myProperty2;
}
?>
<complexType name="MyWSDLStructure">
<sequence>
<element name="MyProperty1" type="xsd:integer"/>
<element name="MyProperty2" type="xsd:string"/>
</sequence>
</complexType>
* Next, Tell the SoapServer when you initialize it to map these two structures together.
<?php
$classmap = array('MyWSDLStructure' => 'MyComplexDataType');
$server = new SoapServer("http://MyServer/MyService.wsdl", array('classmap' => $classmap))
?>
* Finally, have your method return an instance of your class directly, and let the SoapServer take care of encoding!
<?php
public function MySoapCall() {
$o = new MyComplexDataType();
$o->myProperty1 = 1;
$o->myProperty2 = "MyString";
return $o
}
?>`
Jim Plush
12-Jul-2005 04:45
`If you're trying to use the SOAP Extension over SSL with a custom PEM file you need to do this:
$client->_local_cert = "C:\\path\myCert.pem";`
pash_ka
18-May-2005 12:52
`One good tutorial on using this extension is on IBM web site:
"Using the PHP 5 SOAP extension to consume a WebSphere Web service"
http://www.ibm.com /developerworks/library/os-phpws/?ca=dgr-lnxw06PHP5soap`
flobee at gmail dot com
11-May-2005 01:25
`wow, actually a cool program and soap is new for me.
I found out some interessting things i can not debug because the scripts exit without any error messages or notes. :-(
you may have problems with the memory and/or especially on "shared servers" when server load is high.
sometimes the script does the job, sometimes it just stopping at any unknown point.
these are the steps my script does:
* get data from remote server ( ~ 4.5 MB)
* parsing requested object and store the data in a database.
the return with debug messages was intressting:
-> check Mem limit: 30M
-> $client = new new SoapClient($url_wsdl, $options);
-> Memory usage: 185888
-> $client->[requested_method_to_get_data]();
-> check: __getLastResponseHeaders() - after:
-> HTTP/1.1 200 OK // remote server is fine with me :-)
-> Content-Length: 4586742 // I got the data
-> check: Memory usage now: 23098872 // ups !!! this can't be true!!
so, and if now someone on the server takes the rest of RAM the walk thought the data breaks :-(
so, i need to store the xml tree ($client->client->__last_response) and parsing it by the classical way. (if you would request more RAM, you may get in trouble with the admin if you run a script like this more often! (on shared servers)`
OrionI
18-Apr-2005 08:12
`If you're having problems calling a .NET web service, see the comments over on http://php.net/soap_soapclient_soapcall (the __soapCall method).`
kucerar at hhmi dot org
25-Mar-2005 12:04
`Here are 73 test cases that detail the kinds of schemas that PHP5 currently supports and the structures you are expected to plug into them for the return value from your services. Much better than trying to guess!
http://cvs.php.net/co.php/pecl/soap/tests/schema
You can cycle through the listings by changing the main index in the URL below, rather than go in and out of the pages
http://cvs.php.net/co.php/pecl/soap/tests/schema/schema052.phpt?r=1.2
I downloaded the whole thing with this, CVS might work too.
http://www.httrack.com/
With them all downloaded I just browse them with Textpad.`
Norman Clarke <norman at dontblink dot com>
21-Feb-2005 04:29
`Note that if you should need to set the timeout for your soap request, you can use ini_set to change the value for the default_socket_timeout. I previously used NuSOAP, whose soap client class has a timeout option, and it took me a while to figure out that PHP's soap uses the same socket options as everything else.`
wokan at cox dot net
05-Feb-2005 05:06
`It's not good security practice to pass the username and password in the URI when the point of SSL is to prevent that information from being intercepted. Putting that information in the URI makes it interceptable. HTTPS-Posted values are safe because values passed in the headers are sent after the SSL handshake has been completed.`
martin AT kouba DOT at
25-Jan-2005 09:11
`this is something i wrote to access a webservice with php4
http://kouba.at/projects/soap/`
03-Dec-2004 07:06
`here i found a good collection of tutorials all around soap/web services and/or rss:
http://www.dynamic-webpages.de/05.tutorials.php?kategorie=39`
mikx at mikx dot de
29-Mar-2004 08:12
`It took me a while to properly establish a password protected client connection via https on windows/apache1.3. Here my little guide:
1. The SOAP extension isn't activated by default (PHP5 RC1). Just add "extension=php_soap.dll" to the php.ini and don't forget to set the extension_dir properly (in most cases "c:\php\ext").
2. Add "extension=php_openssl.dll" to the php.ini. This module depends on libeay32.dll and ssleay32.dll - copy them from your php folder to your system32 folder.
3. Restart apache
4. The sourcecode
$client = new SoapClient("https://yourLogin:yourPassword@foo.com/bar.wsdl", array(
"login" => "yourLogin",
"password" => "yourPassword",
"trace" => 1,
"exceptions" => 0));
$client->yourFunction();
print "<pre>\n";
print "Request: \n".htmlspecialchars($client->__getLastRequest()) ."\n";
print "Response: \n".htmlspecialchars($client->__getLastResponse())."\n";
print "</pre>";
Currently it seems to be necessary to add your login and password both in the uri and in the options array. Not sure if this is the expected behavior.`
add a note
is_soap_fault snmpwalkoid

Last updated: Fri, 26 Jan 2007
show source | credits | stats | sitemap | contact | advertising | mirror sites
Copyright © 2001-2007 The PHP Group
All rights reserved.
This mirror generously provided by: Yahoo! Inc.
Last updated: Sat Mar 10 11:33:19 2007 PST