.NET SOAP client

Class is intended to be used with .NET Web Services.

package Default
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

__construct()

__construct(string $wsdl = null, array|\Traversable $options = null
Inherited

Parameters

$wsdl

string

$options

array\Traversable

Exceptions

\Zend\Soap\Exception\ExtensionNotLoadedException

Do request proxy method.

_doRequest(\Zend\Soap\Client\Common $client, string $request, string $location, string $action, integer $version, integer $oneWay = null) : string

May be overridden in subclasses

inherited_from \Zend\Soap\Client::_doRequest()

Parameters

$client

\Zend\Soap\Client\Common

Actual SOAP client.

$request

string

The request body.

$location

string

The SOAP URI.

$action

string

The SOAP action to call.

$version

integer

The SOAP version to use.

$oneWay

integer

(Optional) The number 1 if a response is not expected.

Returns

stringThe XML SOAP response.

Do request proxy method.

_doRequest(\Zend\Soap\Client\Common $client, string $request, string $location, string $action, integer $version, integer $oneWay = null) : mixed
Inherited

May be overridden in subclasses

Parameters

$client

\Zend\Soap\Client\Common

$request

string

$location

string

$action

string

$version

integer

$oneWay

integer

Returns

mixed

Add SOAP input header

addSoapInputHeader(\SoapHeader $header, boolean $permanent = false) : \Zend\Soap\Client\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$header

\SoapHeader

$permanent

boolean

Returns

\Zend\Soap\Client\DotNet

Send an RPC request to the service for a specific method.

call(string $method, array $params = array()) : mixed
Inherited

Unified interface for calling custom remote methods.

inherited_from \Zend\Server\Client::call()

Parameters

$method

string

Name of the method we want to call.

$params

array

List of parameters for the method.

Returns

mixedReturned results.

Retrieve classmap

getClassmap() : mixed
Inherited

Returns

mixed

Get Compression options

getCompressionOptions() : integer
Inherited

Returns

integer

Returns the cURL client that is being used.

getCurlClient() : \Zend\Http\Client\Adapter\Curl

Returns

\Zend\Http\Client\Adapter\Curl

Get encoding

getEncoding() : string
Inherited

Returns

string

Get message encoding method

getEncodingMethod() : integer
Inherited

Returns

integer

Return a list of available functions

getFunctions() : array
Inherited

Exceptions

\Zend\Soap\Exception\UnexpectedValueException

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_from \Zend\Soap\Client::getLastRequestHeaders()

Returns

stringRequest headers.

Retrieve request headers

getLastRequestHeaders() : string
Inherited

Returns

string

Get response XML

getLastResponse() : string
Inherited

Returns

string

Retrieve response headers (as string)

getLastResponseHeaders() : string
inherited_from \Zend\Soap\Client::getLastResponseHeaders()

Returns

stringResponse headers.

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

Get SoapClient object

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

Retrieve typemap

getTypemap() : array
Inherited

Returns

array

Return a list of SOAP types

getTypes() : array
Inherited

Exceptions

\Zend\Soap\Exception\UnexpectedValueException

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\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Returns

\Zend\Soap\Client\DotNet

Set classmap

setClassmap(array $classmap) : \Zend\Soap\Client\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$classmap

array

Exceptions

\Zend\Soap\Exception\InvalidArgumentException for any invalid class in the class map

Returns

\Zend\Soap\Client\DotNet

Set compression options

setCompressionOptions(integer|null $compressionOptions) : \Zend\Soap\Client\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$compressionOptions

integernull

Returns

\Zend\Soap\Client\DotNet

Set cookie

setCookie(string $cookieName, string $cookieValue = null) : \Zend\Soap\Client\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$cookieName

string

$cookieValue

string

Returns

\Zend\Soap\Client\DotNet

Sets the cURL client to use.

setCurlClient(\Zend\Http\Client\Adapter\Curl $curlClient) : \Zend\Soap\Client\DotNet
fluent This method is part of a fluent interface and will return the same instance

Parameters

$curlClient

\Zend\Http\Client\Adapter\Curl

The cURL client.

Returns

\Zend\Soap\Client\DotNet

Set encoding

setEncoding(string $encoding) : \Zend\Soap\Client\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$encoding

string

Exceptions

\Zend\Soap\Exception\InvalidArgumentException with invalid encoding argument

Returns

\Zend\Soap\Client\DotNet

Set message encoding method

setEncodingMethod(integer $use) : \Zend\Soap\Client\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$use

integer

One of the SOAP_ENCODED or SOAP_LITERAL constants

Exceptions

\Zend\Soap\Exception\InvalidArgumentException with invalid message encoding method argument

Returns

\Zend\Soap\Client\DotNet

Set HTTP login

setHttpLogin(string $login) : \Zend\Soap\Client\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$login

string

Returns

\Zend\Soap\Client\DotNet

Set HTTP password

setHttpPassword(string $password) : \Zend\Soap\Client\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$password

string

Returns

\Zend\Soap\Client\DotNet

Set HTTPS client certificate passphrase

setHttpsCertPassphrase(string $passphrase) : \Zend\Soap\Client\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$passphrase

string

Returns

\Zend\Soap\Client\DotNet

Set HTTPS client certificate path

setHttpsCertificate(string $localCert) : \Zend\Soap\Client\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$localCert

string

local certificate path

Exceptions

\Zend\Soap\Exception\InvalidArgumentException with invalid local certificate path argument

Returns

\Zend\Soap\Client\DotNet

Set Location

setLocation(string $location) : \Zend\Soap\Client\DotNet
Inherited

URI in Web Service the target namespace

fluent This method is part of a fluent interface and will return the same instance

Parameters

$location

string

Exceptions

\Zend\Soap\Exception\InvalidArgumentException with invalid uri argument

Returns

\Zend\Soap\Client\DotNet

Sets options.

setOptions(array|\Traversable $options) : \Zend\Soap\Client\DotNet

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

inherited_from \Zend\Soap\Client::setOptions()
fluent This method is part of a fluent interface and will return the same instance

Parameters

$options

array\Traversable

Options.

Exceptions

\InvalidArgumentException If an unsupported option is passed.

Returns

\Zend\Soap\Client\DotNet

Set Options

setOptions(array|\Traversable $options) : \Zend\Soap\Client\DotNet
Inherited

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

fluent This method is part of a fluent interface and will return the same instance

Parameters

$options

array\Traversable

Exceptions

\Zend\Soap\Exception\InvalidArgumentException

Returns

\Zend\Soap\Client\DotNet

Set proxy host

setProxyHost(string $proxyHost) : \Zend\Soap\Client\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$proxyHost

string

Returns

\Zend\Soap\Client\DotNet

Set proxy login

setProxyLogin(string $proxyLogin) : \Zend\Soap\Client\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$proxyLogin

string

Returns

\Zend\Soap\Client\DotNet

Set proxy password

setProxyPassword(string $proxyPassword) : \Zend\Soap\Client\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$proxyPassword

string

Returns

\Zend\Soap\Client\DotNet

Set proxy port

setProxyPort(integer $proxyPort) : \Zend\Soap\Client\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$proxyPort

integer

Returns

\Zend\Soap\Client\DotNet

Set SoapClient object

setSoapClient(\SoapClient $soapClient) : \Zend\Soap\Client\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$soapClient

\SoapClient

Returns

\Zend\Soap\Client\DotNet

Set the SOAP Feature options.

setSoapFeatures(string|integer $feature) : \Zend\Soap\Client\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$feature

stringinteger

Returns

\Zend\Soap\Client\DotNet

Set SOAP version

setSoapVersion(integer $version) : \Zend\Soap\Client\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$version

integer

One of the SOAP_1_1 or SOAP_1_2 constants

Exceptions

\Zend\Soap\Exception\InvalidArgumentException with invalid soap version argument

Returns

\Zend\Soap\Client\DotNet

Set Stream Context

setStreamContext(resource $context) : \Zend\Soap\Client\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$context

resource

Exceptions

\Zend\Soap\Exception\InvalidArgumentException

Returns

\Zend\Soap\Client\DotNet

Set request style

setStyle(integer $style) : \Zend\Soap\Client\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$style

integer

One of the SOAP_RPC or SOAP_DOCUMENT constants

Exceptions

\Zend\Soap\Exception\InvalidArgumentException with invalid style argument

Returns

\Zend\Soap\Client\DotNet

Set typemap with xml to php type mappings with appropriate validation.

setTypemap(array $typeMap) : \Zend\Soap\Client\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$typeMap

array

Exceptions

\Zend\Soap\Exception\InvalidArgumentException

Returns

\Zend\Soap\Client\DotNet

Set URI

setUri(string $uri) : \Zend\Soap\Client\DotNet
Inherited

URI in Web Service the target namespace

fluent This method is part of a fluent interface and will return the same instance

Parameters

$uri

string

Exceptions

\Zend\Soap\Exception\InvalidArgumentException with invalid uri argument

Returns

\Zend\Soap\Client\DotNet

Set the string to use in User-Agent header

setUserAgent(string|null $userAgent) : \Zend\Soap\Client\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$userAgent

stringnull

Returns

\Zend\Soap\Client\DotNet

Set wsdl

setWSDL(string $wsdl) : \Zend\Soap\Client\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$wsdl

string

Returns

\Zend\Soap\Client\DotNet

Set the SOAP WSDL Caching Options

setWSDLCache(string|integer|boolean|null $caching) : \Zend\Soap\Client\DotNet
Inherited
fluent This method is part of a fluent interface and will return the same instance

Parameters

$caching

stringintegerbooleannull

Returns

\Zend\Soap\Client\DotNet

Check for valid URN

validateUrn(string $urn) : boolean
Inherited

Parameters

$urn

string

Exceptions

\Zend\Soap\Exception\InvalidArgumentException on invalid URN

Returns

boolean

Initialize SOAP Client object

_initSoapClientObject() 
Inherited

Exceptions

\Zend\Soap\Exception\ExceptionInterface

Perform arguments pre-processing

_preProcessArguments(array $arguments) : array

My be overridden in descendant classes

inherited_from \Zend\Soap\Client::_preProcessArguments()

Parameters

$arguments

array

Exceptions

\Zend\Soap\Exception\RuntimeException

Returns

array

Perform arguments pre-processing

_preProcessArguments(array $arguments) : array
Inherited

My be overridden in descendant classes

Parameters

$arguments

array

Returns

array

Perform result pre-processing

_preProcessResult(object $result) : mixed

My be overridden in descendant classes

inherited_from \Zend\Soap\Client::_preProcessResult()

Parameters

$result

object

Returns

mixed

Perform result pre-processing

_preProcessResult(array $result) : array
Inherited

My be overridden in descendant classes

Parameters

$result

array

Returns

array

Flattens an HTTP headers array into a string.

flattenHeaders(array $headers) : string

Parameters

$headers

array

The headers to flatten.

Returns

stringThe headers string.

 Properties

 

$cacheWsdl

$cacheWsdl 

Default

null
 

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

$classmap : array

Default

null
 

$compression

$compression 

Default

null
 

$connectionTimeout

$connectionTimeout 

Default

null
 

Curl HTTP client adapter.

$curlClient : \Zend\Http\Client\Adapter\Curl

Default

null
 

Encoding

$encoding : string

Default

'UTF-8'
 

Registered fault exceptions

$faultExceptions : array

Default

array()
 

$features

$features 

Default

null
 

Last invoked method

$lastMethod : string

Default

''
 

The last request headers.

$lastRequestHeaders : string

Default

''
 

The last response headers.

$lastResponseHeaders : string

Default

''
 

$localCert

$localCert 

Default

null
 

$location

$location 

Default

null
   

SOAP client options.

$options : array

Default

array()
 

$passphrase

$passphrase 

Default

null
 

$password

$password 

Default

null
 

Permanent SOAP request headers (shared between requests).

$permanentSoapInputHeaders : array

Default

array()
 

$proxyHost

$proxyHost 

Default

null
 

$proxyLogin

$proxyLogin 

Default

null
 

$proxyPassword

$proxyPassword 

Default

null
 

$proxyPort

$proxyPort 

Default

null
 

SoapClient object

$soapClient : \SoapClient

Default

 

Array of SoapHeader objects

$soapInputHeaders : array<mixed,\SoapHeader>

Default

array()
 

Array of SoapHeader objects

$soapOutputHeaders : array

Default

array()
 

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

$soapVersion : integer

Default

SOAP_1_2
 

$streamContext

$streamContext 

Default

null
 

$style

$style 

Default

null
 

$typemap

$typemap : array

Default

null
 

$uri

$uri 

Default

null
 

$use

$use 

Default

null
 

Should NTLM authentication be used?

$useNtlm : boolean

Default

false
 

$userAgent

$userAgent 

Default

null
 

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

$wsdl : string

Default

null