Zend Framework  1.12
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_Soap_Client Class Reference

Public Member Functions

 __construct ($wsdl=null, $options=null)
 Constructor.
 
 setWsdl ($wsdl)
 Set wsdl.
 
 getWsdl ()
 Get wsdl.
 
 setOptions ($options)
 Set Options.
 
 getOptions ()
 Return array of options suitable for using with SoapClient constructor.
 
 setSoapVersion ($version)
 Set SOAP version.
 
 getSoapVersion ()
 Get SOAP version.
 
 setClassmap (array $classmap)
 Set classmap.
 
 getClassmap ()
 Retrieve classmap.
 
 setEncoding ($encoding)
 Set encoding.
 
 getEncoding ()
 Get encoding.
 
 validateUrn ($urn)
 Check for valid URN.
 
 setUri ($uri)
 Set URI.
 
 getUri ()
 Retrieve URI.
 
 setLocation ($location)
 Set Location.
 
 getLocation ()
 Retrieve URI.
 
 setStyle ($style)
 Set request style.
 
 getStyle ()
 Get request style.
 
 setEncodingMethod ($use)
 Set message encoding method.
 
 getEncodingMethod ()
 Get message encoding method.
 
 setHttpLogin ($login)
 Set HTTP login.
 
 getHttpLogin ()
 Retrieve HTTP Login.
 
 setHttpPassword ($password)
 Set HTTP password.
 
 getHttpPassword ()
 Retrieve HTTP Password.
 
 setProxyHost ($proxyHost)
 Set proxy host.
 
 getProxyHost ()
 Retrieve proxy host.
 
 setProxyPort ($proxyPort)
 Set proxy port.
 
 getProxyPort ()
 Retrieve proxy port.
 
 setProxyLogin ($proxyLogin)
 Set proxy login.
 
 getProxyLogin ()
 Retrieve proxy login.
 
 setProxyPassword ($proxyPassword)
 Set proxy password.
 
 setHttpsCertificate ($localCert)
 Set HTTPS client certificate path.
 
 getHttpsCertificate ()
 Get HTTPS client certificate path.
 
 setHttpsCertPassphrase ($passphrase)
 Set HTTPS client certificate passphrase.
 
 getHttpsCertPassphrase ()
 Get HTTPS client certificate passphrase.
 
 setCompressionOptions ($compressionOptions)
 Set compression options.
 
 getCompressionOptions ()
 Get Compression options.
 
 getProxyPassword ()
 Retrieve proxy password.
 
 setStreamContext ($context)
 Set Stream Context.
 
 getStreamContext ()
 Get Stream Context.
 
 setSoapFeatures ($feature)
 Set the SOAP Feature options.
 
 getSoapFeatures ()
 Return current SOAP Features options.
 
 setWsdlCache ($caching)
 Set the SOAP Wsdl Caching Options.
 
 getWsdlCache ()
 Get current SOAP Wsdl Caching option.
 
 setUserAgent ($userAgent)
 Set the string to use in User-Agent header.
 
 getUserAgent ()
 Get current string to use in User-Agent header.
 
 getLastRequest ()
 Retrieve request XML.
 
 getLastResponse ()
 Get response XML.
 
 getLastRequestHeaders ()
 Retrieve request headers.
 
 getLastResponseHeaders ()
 Retrieve response headers (as string)
 
 getLastMethod ()
 Retrieve last invoked method.
 
 _doRequest (Zend_Soap_Client_Common $client, $request, $location, $action, $version, $one_way=null)
 Do request proxy method.
 
 addSoapInputHeader (SoapHeader $header, $permanent=false)
 Add SOAP input header.
 
 resetSoapInputHeaders ()
 Reset SOAP input headers.
 
 getLastSoapOutputHeaderObjects ()
 Get last SOAP output headers.
 
 __call ($name, $arguments)
 Perform a SOAP call.
 
 getFunctions ()
 Return a list of available functions.
 
 getTypes ()
 Get used types.
 
 setSoapClient (SoapClient $soapClient)
 
 getSoapClient ()
 
 setCookie ($cookieName, $cookieValue=null)
 

Protected Member Functions

 _initSoapClientObject ()
 Initialize SOAP Client object.
 
 _preProcessArguments ($arguments)
 Perform arguments pre-processing.
 
 _preProcessResult ($result)
 Perform result pre-processing.
 

Protected Attributes

 $_encoding = 'UTF-8'
 
 $_classmap = null
 
 $_faultExceptions = array()
 
 $_soapVersion = SOAP_1_2
 
 $_uri = null
 Set of other SoapClient options.
 
 $_location = null
 
 $_style = null
 
 $_use = null
 
 $_login = null
 
 $_password = null
 
 $_proxy_host = null
 
 $_proxy_port = null
 
 $_proxy_login = null
 
 $_proxy_password = null
 
 $_local_cert = null
 
 $_passphrase = null
 
 $_compression = null
 
 $_connection_timeout = null
 
 $_stream_context = null
 
 $_features = null
 
 $_cache_wsdl = null
 
 $_user_agent = null
 
 $_wsdl = null
 
 $_soapClient
 
 $_lastMethod = ''
 
 $_soapInputHeaders = array()
 
 $_permanentSoapInputHeaders = array()
 
 $_soapOutputHeaders = array()
 

Constructor & Destructor Documentation

__construct (   $wsdl = null,
  $options = null 
)

Constructor.

Parameters
string$wsdl
array$options

Member Function Documentation

__call (   $name,
  $arguments 
)

Perform a SOAP call.

Parameters
string$name
array$arguments
Returns
mixed
_doRequest ( Zend_Soap_Client_Common  $client,
  $request,
  $location,
  $action,
  $version,
  $one_way = null 
)

Do request proxy method.

May be overridden in subclasses

_initSoapClientObject ( )
protected

Initialize SOAP Client object.

Exceptions
Zend_Soap_Client_Exception
_preProcessArguments (   $arguments)
protected

Perform arguments pre-processing.

My be overridden in descendant classes

Parameters
array$arguments
_preProcessResult (   $result)
protected

Perform result pre-processing.

My be overridden in descendant classes

Parameters
array$arguments
addSoapInputHeader ( SoapHeader  $header,
  $permanent = false 
)

Add SOAP input header.

Parameters
SoapHeader$header
boolean$permanent
Returns
Zend_Soap_Client
getClassmap ( )

Retrieve classmap.

Returns
mixed
getCompressionOptions ( )

Get Compression options.

Returns
int
getEncoding ( )

Get encoding.

Returns
string
getEncodingMethod ( )

Get message encoding method.

Returns
int
getFunctions ( )

Return a list of available functions.

Returns
array
Exceptions
Zend_Soap_Client_Exception
getHttpLogin ( )

Retrieve HTTP Login.

Returns
string
getHttpPassword ( )

Retrieve HTTP Password.

Returns
string
getHttpsCertificate ( )

Get HTTPS client certificate path.

Returns
string
getHttpsCertPassphrase ( )

Get HTTPS client certificate passphrase.

Returns
string
getLastMethod ( )

Retrieve last invoked method.

Returns
string
getLastRequest ( )

Retrieve request XML.

Returns
string
getLastRequestHeaders ( )

Retrieve request headers.

Returns
string
getLastResponse ( )

Get response XML.

Returns
string
getLastResponseHeaders ( )

Retrieve response headers (as string)

Returns
string
getLastSoapOutputHeaderObjects ( )

Get last SOAP output headers.

Returns
array
getLocation ( )

Retrieve URI.

Returns
string
getOptions ( )

Return array of options suitable for using with SoapClient constructor.

Returns
array
getProxyHost ( )

Retrieve proxy host.

Returns
string
getProxyLogin ( )

Retrieve proxy login.

Returns
string
getProxyPassword ( )

Retrieve proxy password.

Returns
string
getProxyPort ( )

Retrieve proxy port.

Returns
int
getSoapClient ( )
Returns
SoapClient
getSoapFeatures ( )

Return current SOAP Features options.

Returns
int
getSoapVersion ( )

Get SOAP version.

Returns
int
getStreamContext ( )

Get Stream Context.

Returns
resource
getStyle ( )

Get request style.

Returns
int
getTypes ( )

Get used types.

Returns
array Return a list of SOAP types
array
Exceptions
Zend_Soap_Client_Exception
getUri ( )

Retrieve URI.

Returns
string
getUserAgent ( )

Get current string to use in User-Agent header.

Returns
string|null
getWsdl ( )

Get wsdl.

Returns
string
getWsdlCache ( )

Get current SOAP Wsdl Caching option.

Returns
int
resetSoapInputHeaders ( )

Reset SOAP input headers.

Returns
Zend_Soap_Client
setClassmap ( array  $classmap)

Set classmap.

Parameters
array$classmap
Returns
Zend_Soap_Client
Exceptions
Zend_Soap_Client_Exceptionfor any invalid class in the class map
setCompressionOptions (   $compressionOptions)

Set compression options.

Parameters
int | null$compressionOptions
Returns
Zend_Soap_Client
setCookie (   $cookieName,
  $cookieValue = null 
)
Parameters
string$name
string$value
Returns
Zend_Soap_Client
setEncoding (   $encoding)

Set encoding.

Parameters
string$encoding
Returns
Zend_Soap_Client
Exceptions
Zend_Soap_Client_Exceptionwith invalid encoding argument
setEncodingMethod (   $use)

Set message encoding method.

Parameters
int$useOne of the SOAP_ENCODED or SOAP_LITERAL constants
Returns
Zend_Soap_Client
Exceptions
Zend_Soap_Client_Exceptionwith invalid message encoding method argument
setHttpLogin (   $login)

Set HTTP login.

Parameters
string$login
Returns
Zend_Soap_Client
setHttpPassword (   $password)

Set HTTP password.

Parameters
string$password
Returns
Zend_Soap_Client
setHttpsCertificate (   $localCert)

Set HTTPS client certificate path.

Parameters
string$localCertlocal certificate path
Returns
Zend_Soap_Client
Exceptions
Zend_Soap_Client_Exceptionwith invalid local certificate path argument
setHttpsCertPassphrase (   $passphrase)

Set HTTPS client certificate passphrase.

Parameters
string$passphrase
Returns
Zend_Soap_Client
setLocation (   $location)

Set Location.

URI in Web Service the target namespace

Parameters
string$location
Returns
Zend_Soap_Client
Exceptions
Zend_Soap_Client_Exceptionwith invalid uri argument
setOptions (   $options)

Set Options.

Allows setting options as an associative array of option => value pairs.

Parameters
array | Zend_Config$options
Returns
Zend_Soap_Client
Exceptions
Zend_SoapClient_Exception
setProxyHost (   $proxyHost)

Set proxy host.

Parameters
string$proxyHost
Returns
Zend_Soap_Client
setProxyLogin (   $proxyLogin)

Set proxy login.

Parameters
string$proxyLogin
Returns
Zend_Soap_Client
setProxyPassword (   $proxyPassword)

Set proxy password.

Parameters
string$proxyLogin
Returns
Zend_Soap_Client
setProxyPort (   $proxyPort)

Set proxy port.

Parameters
int$proxyPort
Returns
Zend_Soap_Client
setSoapClient ( SoapClient  $soapClient)
Parameters
SoapClient$soapClient
Returns
Zend_Soap_Client
setSoapFeatures (   $feature)

Set the SOAP Feature options.

Parameters
string | int$feature
Returns
Zend_Soap_Client
setSoapVersion (   $version)

Set SOAP version.

Parameters
int$versionOne of the SOAP_1_1 or SOAP_1_2 constants
Returns
Zend_Soap_Client
Exceptions
Zend_Soap_Client_Exceptionwith invalid soap version argument
setStreamContext (   $context)

Set Stream Context.

Returns
Zend_Soap_Client
See Also
Zend_Soap_Client_Exception
setStyle (   $style)

Set request style.

Parameters
int$styleOne of the SOAP_RPC or SOAP_DOCUMENT constants
Returns
Zend_Soap_Client
Exceptions
Zend_Soap_Client_Exceptionwith invalid style argument
setUri (   $uri)

Set URI.

URI in Web Service the target namespace

Parameters
string$uri
Returns
Zend_Soap_Client
Exceptions
Zend_Soap_Client_Exceptionwith invalid uri argument
setUserAgent (   $userAgent)

Set the string to use in User-Agent header.

Parameters
string | null$userAgent
Returns
Zend_Soap_Client
setWsdl (   $wsdl)

Set wsdl.

Parameters
string$wsdl
Returns
Zend_Soap_Client
setWsdlCache (   $caching)

Set the SOAP Wsdl Caching Options.

Parameters
string | int | boolean | null$caching
Returns
Zend_Soap_Client
validateUrn (   $urn)

Check for valid URN.

Parameters
string$urn
Returns
true
Exceptions
Zend_Soap_Client_Exceptionon invalid URN

Member Data Documentation

$_cache_wsdl = null
protected
$_classmap = null
protected
$_compression = null
protected
$_connection_timeout = null
protected
$_encoding = 'UTF-8'
protected
$_faultExceptions = array()
protected
$_features = null
protected
$_lastMethod = ''
protected
$_local_cert = null
protected
$_location = null
protected
$_login = null
protected
$_passphrase = null
protected
$_password = null
protected
$_permanentSoapInputHeaders = array()
protected
$_proxy_host = null
protected
$_proxy_login = null
protected
$_proxy_password = null
protected
$_proxy_port = null
protected
$_soapClient
protected
$_soapInputHeaders = array()
protected
$_soapOutputHeaders = array()
protected
$_soapVersion = SOAP_1_2
protected
$_stream_context = null
protected
$_style = null
protected
$_uri = null
protected

Set of other SoapClient options.

$_use = null
protected
$_user_agent = null
protected
$_wsdl = null
protected