Class is intended to be used with .Net Web Services.
Important! Class is at experimental stage now.
Please leave your notes, compatiblity issues reports or
suggestions in fw-webservices@lists.zend.com or fw-general@lists.com
category |
Zend |
package |
Zend_Soap |
subpackage |
Client |
inherited_from |
\Zend_Soap_Client |
Methods
Perform a SOAP call
__call(string $name, array $arguments) : mixed
Inherited
Parameters
$name
string
$arguments
array
Returns
mixed
Constructor
__construct(string $wsdl = null
, array $options = null
)
inherited_from |
\Zend_Soap_Client::__construct() |
Parameters
$wsdl
string
$options
array
Constructor
__construct(string $wsdl = null
, array $options = null
)
Inherited
Parameters
$wsdl
string
$options
array
Retrieve classmap
getClassmap() : mixed
Inherited
Get Compression options
getCompressionOptions() : integer
Inherited
Get encoding
getEncoding() : string
Inherited
Get message encoding method
getEncodingMethod() : integer
Inherited
Get the exceptions option
getExceptions() : boolean | null
Inherited
The exceptions option is a boolean value defining whether soap errors
throw exceptions.
Returns
boolean
null
Return a list of available functions
getFunctions() : array
Inherited
Exceptions
\Zend_Soap_Client_Exception |
|
Returns
array
Retrieve HTTP Login
getHttpLogin() : string
Inherited
Retrieve HTTP Password
getHttpPassword() : string
Inherited
Get HTTPS client certificate passphrase
getHttpsCertPassphrase() : string
Inherited
Get HTTPS client certificate path
getHttpsCertificate() : string
Inherited
Retrieve last invoked method
getLastMethod() : string
Inherited
Retrieve request XML
getLastRequest() : string
Inherited
Get response XML
getLastResponse() : string
Inherited
Retrieve URI
getLocation() : string
Inherited
Return array of options suitable for using with SoapClient constructor
getOptions() : array
Inherited
Retrieve proxy host
getProxyHost() : string
Inherited
Retrieve proxy login
getProxyLogin() : string
Inherited
Retrieve proxy password
getProxyPassword() : string
Inherited
Retrieve proxy port
getProxyPort() : integer
Inherited
getSoapClient()
getSoapClient() : \SoapClient
Inherited
Return current SOAP Features options
getSoapFeatures() : integer
Inherited
Get SOAP version
getSoapVersion() : integer
Inherited
Get Stream Context
getStreamContext() : resource
Inherited
Get request style
getStyle() : integer
Inherited
Return a list of SOAP types
getTypes() : array
Inherited
Exceptions
\Zend_Soap_Client_Exception |
|
Returns
array
Retrieve URI
getUri() : string
Inherited
Get current string to use in User-Agent header
getUserAgent() : string | null
Inherited
Get wsdl
getWsdl() : string
Inherited
Get current SOAP Wsdl Caching option
getWsdlCache() : integer
Inherited
Set classmap
setClassmap(array $classmap) : \Zend_Soap_Client
Inherited
Parameters
$classmap
array
Exceptions
\Zend_Soap_Client_Exception |
for any invalid class in the class map |
Returns
\Zend_Soap_Client
Set compression options
setCompressionOptions(integer|null $compressionOptions) : \Zend_Soap_Client
Inherited
Parameters
$compressionOptions
integer
null
Returns
\Zend_Soap_Client
setCookie()
setCookie($cookieName, $cookieValue = null
) : \Zend_Soap_Client
Inherited
Parameters
$cookieName
$cookieValue
Returns
\Zend_Soap_Client
Set encoding
setEncoding(string $encoding) : \Zend_Soap_Client
Inherited
Parameters
$encoding
string
Exceptions
\Zend_Soap_Client_Exception |
with invalid encoding argument |
Returns
\Zend_Soap_Client
Set message encoding method
setEncodingMethod(integer $use) : \Zend_Soap_Client
Inherited
Parameters
$use
integer
One of the SOAP_ENCODED or SOAP_LITERAL constants
Exceptions
\Zend_Soap_Client_Exception |
with invalid message encoding method argument |
Returns
\Zend_Soap_Client
Set the exceptions option
setExceptions(boolean $exceptions) : \Zend_Soap_Client_DotNet
Inherited
The exceptions option is a boolean value defining whether soap errors
throw exceptions.
see |
|
fluent |
This method is part of a fluent interface and will return the same instance |
Parameters
$exceptions
boolean
Returns
\Zend_Soap_Client_DotNet
Set HTTP login
setHttpLogin(string $login) : \Zend_Soap_Client
Inherited
Parameters
$login
string
Returns
\Zend_Soap_Client
Set HTTP password
setHttpPassword(string $password) : \Zend_Soap_Client
Inherited
Parameters
$password
string
Returns
\Zend_Soap_Client
Set HTTPS client certificate passphrase
setHttpsCertPassphrase(string $passphrase) : \Zend_Soap_Client
Inherited
Parameters
$passphrase
string
Returns
\Zend_Soap_Client
Set HTTPS client certificate path
setHttpsCertificate(string $localCert) : \Zend_Soap_Client
Inherited
Parameters
$localCert
string
local certificate path
Exceptions
\Zend_Soap_Client_Exception |
with invalid local certificate path argument |
Returns
\Zend_Soap_Client
Set Location
setLocation(string $location) : \Zend_Soap_Client
Inherited
URI in Web Service the target namespace
Parameters
$location
string
Exceptions
\Zend_Soap_Client_Exception |
with invalid uri argument |
Returns
\Zend_Soap_Client
Set Options
setOptions(array|\Zend_Config $options) : \Zend_Soap_Client
Inherited
Allows setting options as an associative array of option => value pairs.
Parameters
$options
array
\Zend_Config
Exceptions
\Zend_SoapClient_Exception |
|
Returns
\Zend_Soap_Client
Set proxy host
setProxyHost(string $proxyHost) : \Zend_Soap_Client
Inherited
Parameters
$proxyHost
string
Returns
\Zend_Soap_Client
Set proxy login
setProxyLogin(string $proxyLogin) : \Zend_Soap_Client
Inherited
Parameters
$proxyLogin
string
Returns
\Zend_Soap_Client
Set proxy password
setProxyPassword($proxyPassword) : \Zend_Soap_Client
Inherited
Parameters
$proxyPassword
Returns
\Zend_Soap_Client
Set proxy port
setProxyPort(integer $proxyPort) : \Zend_Soap_Client
Inherited
Parameters
$proxyPort
integer
Returns
\Zend_Soap_Client
setSoapClient()
setSoapClient(\SoapClient $soapClient) : \Zend_Soap_Client
Inherited
Parameters
$soapClient
\SoapClient
Returns
\Zend_Soap_Client
Set the SOAP Feature options.
setSoapFeatures(string|integer $feature) : \Zend_Soap_Client
Inherited
Parameters
$feature
string
integer
Returns
\Zend_Soap_Client
Set SOAP version
setSoapVersion(integer $version) : \Zend_Soap_Client
Inherited
Parameters
$version
integer
One of the SOAP_1_1 or SOAP_1_2 constants
Exceptions
\Zend_Soap_Client_Exception |
with invalid soap version argument |
Returns
\Zend_Soap_Client
Set Stream Context
setStreamContext($context) : \Zend_Soap_Client
Inherited
Parameters
$context
Returns
\Zend_Soap_Client
Set request style
setStyle(integer $style) : \Zend_Soap_Client
Inherited
Parameters
$style
integer
One of the SOAP_RPC or SOAP_DOCUMENT constants
Exceptions
\Zend_Soap_Client_Exception |
with invalid style argument |
Returns
\Zend_Soap_Client
Set URI
setUri(string $uri) : \Zend_Soap_Client
Inherited
URI in Web Service the target namespace
Parameters
$uri
string
Exceptions
\Zend_Soap_Client_Exception |
with invalid uri argument |
Returns
\Zend_Soap_Client
Set the string to use in User-Agent header
setUserAgent(string|null $userAgent) : \Zend_Soap_Client
Inherited
Parameters
$userAgent
string
null
Returns
\Zend_Soap_Client
Set wsdl
setWsdl(string $wsdl) : \Zend_Soap_Client
Inherited
Parameters
$wsdl
string
Returns
\Zend_Soap_Client
Set the SOAP Wsdl Caching Options
setWsdlCache(string|integer|boolean|null $caching) : \Zend_Soap_Client
Inherited
Parameters
$caching
string
integer
boolean
null
Returns
\Zend_Soap_Client
Check for valid URN
validateUrn(string $urn) : true
Inherited
Parameters
$urn
string
Exceptions
\Zend_Soap_Client_Exception |
on invalid URN |
Returns
true
Initialize SOAP Client object
_initSoapClientObject()
Inherited
Exceptions
\Zend_Soap_Client_Exception |
|
Perform arguments pre-processing
_preProcessArguments(array $arguments)
My be overridden in descendant classes
inherited_from |
\Zend_Soap_Client::_preProcessArguments() |
Parameters
$arguments
array
Exceptions
\Zend_Soap_Client_Exception |
|
Perform arguments pre-processing
_preProcessArguments(array $arguments)
Inherited
My be overridden in descendant classes
Parameters
$arguments
array
Perform result pre-processing
_preProcessResult($result)
My be overridden in descendant classes
inherited_from |
\Zend_Soap_Client::_preProcessResult() |
Parameters
$result
Perform result pre-processing
_preProcessResult($result)
Inherited
My be overridden in descendant classes
Parameters
$result
Properties
$_cache_wsdl
$_cache_wsdl
Array of SOAP type => PHP class pairings for handling return/incoming values
$_classmap : array
$_compression
$_compression
$_connection_timeout
$_connection_timeout
Encoding
$_encoding : string
$_exceptions
$_exceptions
Registered fault exceptions
$_faultExceptions : array
Last invoked method
$_lastMethod : string
$_local_cert
$_local_cert
$_passphrase
$_passphrase
$_proxy_host
$_proxy_host
$_proxy_login
$_proxy_login
$_proxy_password
$_proxy_password
$_proxy_port
$_proxy_port
SoapClient object
$_soapClient : \SoapClient
SOAP version to use; SOAP_1_2 by default, to allow processing of headers
$_soapVersion : integer
$_stream_context
$_stream_context
Set of other SoapClient options
$_uri
$_user_agent
$_user_agent
WSDL used to access server
It also defines Zend_Soap_Client working mode (WSDL vs non-WSDL)
$_wsdl : string