Zend_Soap_Client_Local

Class is intended to be used as local SOAP client which works with a provided Server object.

Could be used for development or testing purposes.

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

Local client constructor

__construct(\Zend_Soap_Server $server, string $wsdl, array $options = null
inherited_from \Zend_Soap_Client::__construct()

Parameters

$server

\Zend_Soap_Server

$wsdl

string

$options

array

Constructor

__construct(string $wsdl = null, array $options = null
Inherited

Parameters

$wsdl

string

$options

array

Add SOAP input header

addSoapInputHeader(\SoapHeader $header, boolean $permanent = false) : \Zend_Soap_Client
Inherited

Parameters

$header

\SoapHeader

$permanent

boolean

Returns

\Zend_Soap_Client

Retrieve classmap

getClassmap() : mixed
Inherited

Returns

mixed

Get Compression options

getCompressionOptions() : integer
Inherited

Returns

integer

Get encoding

getEncoding() : string
Inherited

Returns

string

Get message encoding method

getEncodingMethod() : integer
Inherited

Returns

integer

Get the exceptions option

getExceptions() : boolean | null
Inherited

The exceptions option is a boolean value defining whether soap errors throw exceptions.

see

Returns

booleannull

Return a list of available functions

getFunctions() : array
Inherited

Exceptions

\Zend_Soap_Client_Exception

Returns

array

Retrieve HTTP Login

getHttpLogin() : string
Inherited

Returns

string

Retrieve HTTP Password

getHttpPassword() : string
Inherited

Returns

string

Get HTTPS client certificate passphrase

getHttpsCertPassphrase() : string
Inherited

Returns

string

Get HTTPS client certificate path

getHttpsCertificate() : string
Inherited

Returns

string

Retrieve last invoked method

getLastMethod() : string
Inherited

Returns

string

Retrieve request XML

getLastRequest() : string
Inherited

Returns

string

Retrieve request headers

getLastRequestHeaders() : string
Inherited

Returns

string

Get response XML

getLastResponse() : string
Inherited

Returns

string

Retrieve response headers (as string)

getLastResponseHeaders() : string
Inherited

Returns

string

Get last SOAP output headers

getLastSoapOutputHeaderObjects() : array
Inherited

Returns

array

Retrieve URI

getLocation() : string
Inherited

Returns

string

Return array of options suitable for using with SoapClient constructor

getOptions() : array
Inherited

Returns

array

Retrieve proxy host

getProxyHost() : string
Inherited

Returns

string

Retrieve proxy login

getProxyLogin() : string
Inherited

Returns

string

Retrieve proxy password

getProxyPassword() : string
Inherited

Returns

string

Retrieve proxy port

getProxyPort() : integer
Inherited

Returns

integer

getSoapClient()

getSoapClient() : \SoapClient
Inherited

Returns

\SoapClient

Return current SOAP Features options

getSoapFeatures() : integer
Inherited

Returns

integer

Get SOAP version

getSoapVersion() : integer
Inherited

Returns

integer

Get Stream Context

getStreamContext() : resource
Inherited

Returns

resource

Get request style

getStyle() : integer
Inherited

Returns

integer

Return a list of SOAP types

getTypes() : array
Inherited

Exceptions

\Zend_Soap_Client_Exception

Returns

array

Retrieve URI

getUri() : string
Inherited

Returns

string

Get current string to use in User-Agent header

getUserAgent() : string | null
Inherited

Returns

stringnull

Get wsdl

getWsdl() : string
Inherited

Returns

string

Get current SOAP Wsdl Caching option

getWsdlCache() : integer
Inherited

Returns

integer

Reset SOAP input headers

resetSoapInputHeaders() : \Zend_Soap_Client
Inherited

Returns

\Zend_Soap_Client

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

integernull

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_Local
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_Local

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

stringinteger

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

stringnull

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

stringintegerbooleannull

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) 
Inherited

My be overridden in descendant classes

Parameters

$arguments

array

Perform result pre-processing

_preProcessResult($result) 
Inherited

My be overridden in descendant classes

Parameters

$result

 Properties

 

$_cache_wsdl

$_cache_wsdl 

Default

null
 

Array of SOAP type => PHP class pairings for handling return/incoming values

$_classmap : array

Default

null
 

$_compression

$_compression 

Default

null
 

$_connection_timeout

$_connection_timeout 

Default

null
 

Encoding

$_encoding : string

Default

'UTF-8'
 

$_exceptions

$_exceptions 

Default

null
 

Registered fault exceptions

$_faultExceptions : array

Default

array()
 

$_features

$_features 

Default

null
 

Last invoked method

$_lastMethod : string

Default

''
 

$_local_cert

$_local_cert 

Default

null
 

$_location

$_location 

Default

null
   

$_passphrase

$_passphrase 

Default

null
 

$_password

$_password 

Default

null
 

Permanent SOAP request headers (shared between requests).

$_permanentSoapInputHeaders : array

Default

array()

Array of SoapHeader objects

 

$_proxy_host

$_proxy_host 

Default

null
   

$_proxy_password

$_proxy_password 

Default

null
 

$_proxy_port

$_proxy_port 

Default

null
 

Server object

$_server : \Zend_Soap_Server

Default

 

SoapClient object

$_soapClient : \SoapClient

Default

 

SOAP request headers.

$_soapInputHeaders : array

Default

array()

Array of SoapHeader objects

 

Output SOAP headers.

$_soapOutputHeaders : array

Default

array()

Array of SoapHeader objects

 

SOAP version to use; SOAP_1_2 by default, to allow processing of headers

$_soapVersion : integer

Default

SOAP_1_2
 

$_stream_context

$_stream_context 

Default

null
 

$_style

$_style 

Default

null
 

Set of other SoapClient options

$_uri 

Default

null
 

$_use

$_use 

Default

null
 

$_user_agent

$_user_agent 

Default

null
 

WSDL used to access server It also defines Zend_Soap_Client working mode (WSDL vs non-WSDL)

$_wsdl : string

Default

null