Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Zend_Soap_Client

array
$_classmap= 'null'
Array of SOAP type => PHP class pairings for handling return/incoming values
null
Details
array
$_faultExceptions= 'array()'
Registered fault exceptions
array()
Details
array
$_permanentSoapInputHeaders= 'array()'
Permanent SOAP request headers (shared between requests).
Array of SoapHeader objects
array()
Details
array
$_soapInputHeaders= 'array()'
SOAP request headers.
Array of SoapHeader objects
array()
Details
array
$_soapOutputHeaders= 'array()'
Output SOAP headers.
Array of SoapHeader objects
array()
Details
int
$_soapVersion= 'SOAP_1_2'
SOAP version to use; SOAP_1_2 by default, to allow processing of headers
SOAP_1_2
Details
__call(
string $name, array $arguments
)
:
mixed
Perform a SOAP call
Name | Type | Description |
---|---|---|
$name | string | |
$arguments | array |
Type | Description |
---|---|
mixed |

__construct(
string $wsdl
=
null, array $options
=
null
)
:
void
Constructor
Name | Type | Description |
---|---|---|
$wsdl | string | |
$options | array |

_initSoapClientObject(
)
:
void
Initialize SOAP Client object
Exception | Description |
---|---|
\Zend_Soap_Client_Exception |

_preProcessArguments(
array $arguments
)
:
void
Perform arguments pre-processing
My be overridden in descendant classes
Name | Type | Description |
---|---|---|
$arguments | array |

_preProcessResult(
$result
)
:
void
Perform result pre-processing
My be overridden in descendant classes
Name | Type | Description |
---|---|---|
$result |

addSoapInputHeader(
\SoapHeader $header, boolean $permanent
=
false
)
:
\Zend_Soap_Client
Add SOAP input header
Name | Type | Description |
---|---|---|
$header | \SoapHeader | |
$permanent | boolean |
Type | Description |
---|---|
\Zend_Soap_Client |

getHttpsCertPassphrase(
)
:
string
Get HTTPS client certificate passphrase
Type | Description |
---|---|
string |

getLastResponseHeaders(
)
:
string
Retrieve response headers (as string)
Type | Description |
---|---|
string |

getLastSoapOutputHeaderObjects(
)
:
array
Get last SOAP output headers
Type | Description |
---|---|
array |

getOptions(
)
:
array
Return array of options suitable for using with SoapClient constructor
Type | Description |
---|---|
array |

getUserAgent(
)
:
string|null
Get current string to use in User-Agent header
Type | Description |
---|---|
string|null |

resetSoapInputHeaders(
)
:
\Zend_Soap_Client
Reset SOAP input headers
Type | Description |
---|---|
\Zend_Soap_Client |

setClassmap(
array $classmap
)
:
\Zend_Soap_Client
Set classmap
Name | Type | Description |
---|---|---|
$classmap | array |
Type | Description |
---|---|
\Zend_Soap_Client |
Exception | Description |
---|---|
\Zend_Soap_Client_Exception | for any invalid class in the class map |

setCompressionOptions(
int|null $compressionOptions
)
:
\Zend_Soap_Client
Set compression options
Name | Type | Description |
---|---|---|
$compressionOptions | int|null |
Type | Description |
---|---|
\Zend_Soap_Client |

setCookie(
$cookieName, $cookieValue
=
null
)
:
\Zend_Soap_Client
Name | Type | Description |
---|---|---|
$cookieName | ||
$cookieValue |
Type | Description |
---|---|
\Zend_Soap_Client |

setEncoding(
string $encoding
)
:
\Zend_Soap_Client
Set encoding
Name | Type | Description |
---|---|---|
$encoding | string |
Type | Description |
---|---|
\Zend_Soap_Client |
Exception | Description |
---|---|
\Zend_Soap_Client_Exception | with invalid encoding argument |

setEncodingMethod(
int $use
)
:
\Zend_Soap_Client
Set message encoding method
Name | Type | Description |
---|---|---|
$use | int | One of the SOAP_ENCODED or SOAP_LITERAL constants |
Type | Description |
---|---|
\Zend_Soap_Client |
Exception | Description |
---|---|
\Zend_Soap_Client_Exception | with invalid message encoding method argument |

setHttpsCertPassphrase(
string $passphrase
)
:
\Zend_Soap_Client
Set HTTPS client certificate passphrase

setHttpsCertificate(
string $localCert
)
:
\Zend_Soap_Client
Set HTTPS client certificate path
Name | Type | Description |
---|---|---|
$localCert | string | local certificate path |
Type | Description |
---|---|
\Zend_Soap_Client |
Exception | Description |
---|---|
\Zend_Soap_Client_Exception | with invalid local certificate path argument |

setLocation(
string $location
)
:
\Zend_Soap_Client
Set Location
URI in Web Service the target namespace
Name | Type | Description |
---|---|---|
$location | string |
Type | Description |
---|---|
\Zend_Soap_Client |
Exception | Description |
---|---|
\Zend_Soap_Client_Exception | with invalid uri argument |

setOptions(
array|\Zend_Config $options
)
:
\Zend_Soap_Client
Set Options
Allows setting options as an associative array of option => value pairs.
Name | Type | Description |
---|---|---|
$options | array|\Zend_Config |
Type | Description |
---|---|
\Zend_Soap_Client |
Exception | Description |
---|---|
\Zend_SoapClient_Exception |

setSoapVersion(
int $version
)
:
\Zend_Soap_Client
Set SOAP version
Name | Type | Description |
---|---|---|
$version | int | One of the SOAP_1_1 or SOAP_1_2 constants |
Type | Description |
---|---|
\Zend_Soap_Client |
Exception | Description |
---|---|
\Zend_Soap_Client_Exception | with invalid soap version argument |

setStyle(
int $style
)
:
\Zend_Soap_Client
Set request style
Name | Type | Description |
---|---|---|
$style | int | One of the SOAP_RPC or SOAP_DOCUMENT constants |
Type | Description |
---|---|
\Zend_Soap_Client |
Exception | Description |
---|---|
\Zend_Soap_Client_Exception | with invalid style argument |

setUri(
string $uri
)
:
\Zend_Soap_Client
Set URI
URI in Web Service the target namespace
Name | Type | Description |
---|---|---|
$uri | string |
Type | Description |
---|---|
\Zend_Soap_Client |
Exception | Description |
---|---|
\Zend_Soap_Client_Exception | with invalid uri argument |

setUserAgent(
string|null $userAgent
)
:
\Zend_Soap_Client
Set the string to use in User-Agent header

setWsdlCache(
string|int|boolean|null $caching
)
:
\Zend_Soap_Client
Set the SOAP Wsdl Caching Options
Name | Type | Description |
---|---|---|
$caching | string|int|boolean|null |
Type | Description |
---|---|
\Zend_Soap_Client |

validateUrn(
string $urn
)
:
true
Check for valid URN
Name | Type | Description |
---|---|---|
$urn | string |
Type | Description |
---|---|
true |
Exception | Description |
---|---|
\Zend_Soap_Client_Exception | on invalid URN |