SOAP

Table of Contents

Introduction
Installing/Configuring
Predefined Constants
SOAP Functions
- is_soap_fault — Checks if a SOAP call has failed
- use_soap_error_handler — Set whether to use the SOAP error handler
SoapClient — The SoapClient class
- SoapClient::__call — Calls a SOAP function (deprecated)
- SoapClient::__construct — SoapClient constructor
- SoapClient::__doRequest — Performs a SOAP request
- SoapClient::__getFunctions — Returns list of available SOAP functions
- SoapClient::__getLastRequest — Returns last SOAP request
- SoapClient::__getLastRequestHeaders — Returns the SOAP headers from the last request
- SoapClient::__getLastResponse — Returns last SOAP response
- SoapClient::__getLastResponseHeaders — Returns the SOAP headers from the last response
- SoapClient::__getTypes — Returns a list of SOAP types
- SoapClient::__setCookie — The __setCookie purpose
- SoapClient::__setLocation — Sets the location of the Web service to use
- SoapClient::__setSoapHeaders — Sets SOAP headers for subsequent calls
- SoapClient::__soapCall — Calls a SOAP function
- SoapClient::SoapClient — SoapClient constructor
SoapServer — The SoapServer class
- SoapServer::addFunction — Adds one or more functions to handle SOAP requests
- SoapServer::addSoapHeader — Add a SOAP header to the response
- SoapServer::__construct — SoapServer constructor
- SoapServer::fault — Issue SoapServer fault indicating an error
- SoapServer::getFunctions — Returns list of defined functions
- SoapServer::handle — Handles a SOAP request
- SoapServer::setClass — Sets the class which handles SOAP requests
- SoapServer::setObject — Sets the object which will be used to handle SOAP requests
- SoapServer::setPersistence — Sets SoapServer persistence mode
- SoapServer::SoapServer — SoapServer constructor
SoapFault — The SoapFault class
- SoapFault::__construct — SoapFault constructor
- SoapFault::SoapFault — SoapFault constructor
- SoapFault::__toString — Obtain a string representation of a SoapFault
SoapHeader — The SoapHeader class
- SoapHeader::__construct — SoapHeader constructor
- SoapHeader::SoapHeader — SoapHeader constructor
SoapParam — The SoapParam class
- SoapParam::__construct — SoapParam constructor
- SoapParam::SoapParam — SoapParam constructor
SoapVar — The SoapVar class
- SoapVar::__construct — SoapVar constructor
- SoapVar::SoapVar — SoapVar constructor

The SoapClient class

Introduction

The SoapClient class provides a client for » SOAP 1.1, » SOAP 1.2 servers. It can be used in WSDL or non-WSDL mode.

Class synopsis

SoapClient

class SoapClient {

/* Methods */

public mixed __call ( string $function_name , string $arguments )

public SoapClient ( mixed $wsdl [, array $options ] )

public string __doRequest ( string $request , string $location , string $action , int $version [, int $one_way = 0 ] )

public array __getFunctions ( void )

public string __getLastRequest ( void )

public string __getLastRequestHeaders ( void )

public string __getLastResponse ( void )

public string __getLastResponseHeaders ( void )

public array __getTypes ( void )

public void __setCookie ( string $name [, string $value ] )

public string __setLocation ([ string $new_location ] )

public bool __setSoapHeaders ([ mixed $soapheaders ] )

public mixed __soapCall ( string $function_name , array $arguments [, array $options [, mixed $input_headers [, array &$output_headers ]]] )

public SoapClient ( mixed $wsdl [, array $options ] )

}

The SoapServer class

Introduction

The SoapServer class provides a server for the » SOAP 1.1 and » SOAP 1.2 protocols. It can be used with or without a WSDL service description.

Class synopsis

SoapServer

class SoapServer {

/* Methods */

public void addFunction ( mixed $functions )

public void addSoapHeader ( SoapHeader $object )

public __construct ( mixed $wsdl [, array $options ] )

public void fault ( string $code , string $string [, string $actor [, string $details [, string $name ]]] )

public array getFunctions ( void )

public void handle ([ string $soap_request ] )

public void setClass ( string $class_name [, mixed $args [, mixed $... ]] )

public void setObject ( object $object )

public void setPersistence ( int $mode )

public SoapServer ( mixed $wsdl [, array $options ] )

}

The SoapFault class

Introduction

Represents a SOAP fault.

Class synopsis

SoapFault

class SoapFault extends Exception {

/* Inherited properties */

protected string $message ;

protected int $code ;

protected string $file ;

protected int $line ;

/* Methods */

__construct ( string $faultcode , string $faultstring [, string $faultactor [, string $detail [, string $faultname [, string $headerfault ]]]] )

SoapFault ( string $faultcode , string $faultstring [, string $faultactor [, string $detail [, string $faultname [, string $headerfault ]]]] )

public string __toString ( void )

/* Inherited methods */

final public string Exception::getMessage ( void )

final public Exception Exception::getPrevious ( void )

final public mixed Exception::getCode ( void )

final public string Exception::getFile ( void )

final public int Exception::getLine ( void )

final public array Exception::getTrace ( void )

final public string Exception::getTraceAsString ( void )

public string Exception::__toString ( void )

final private void Exception::__clone ( void )

}

The SoapHeader class

Introduction

Represents a SOAP header.

Class synopsis

SoapHeader

class SoapHeader {

/* Methods */

__construct ( string $namespace , string $name [, mixed $data [, bool $mustunderstand [, string $actor ]]] )

SoapHeader ( string $namespace , string $name [, mixed $data [, bool $mustunderstand = false [, string $actor ]]] )

}

The SoapParam class

Introduction

Represents parameter to a SOAP call.

Class synopsis

SoapParam

class SoapParam {

/* Methods */

__construct ( mixed $data , string $name )

SoapParam ( mixed $data , string $name )

}

The SoapVar class

Introduction

A class representing a variable or object for use with SOAP services.

Class synopsis

SoapVar

class SoapVar {

/* Methods */

__construct ( string $data , string $encoding [, string $type_name [, string $type_namespace [, string $node_name [, string $node_namespace ]]]] )

SoapVar ( mixed $data , string $encoding [, string $type_name [, string $type_namespace [, string $node_name [, string $node_namespace ]]]] )

}