Zend Framework
Back to top  

 Methods

Perform a SOAP call

__call(string $name, array $arguments) : mixed
Inherited

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

Parameters

$name

string

$arguments

array

Returns

mixed

Constructor

__construct(string $wsdl, array $options) 

Parameters

$wsdl

string

$options

array

Exceptions

\Zend\Soap\Exception\ExtensionNotLoadedException

Do request proxy method.

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

May be overridden in subclasses

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

int

The SOAP version to use.

$oneWay

int

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

Returns

stringThe XML SOAP response.

Add SOAP input header

addSoapInputHeader(\SoapHeader $header, bool $permanent) : \Zend\Soap\self
Inherited

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

Parameters

$header

\SoapHeader

$permanent

bool

Returns

\Zend\Soap\self

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

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

Unified interface for calling custom remote methods.

inherited_from \Zend\Soap\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

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

Returns

mixed

Get Compression options

getCompressionOptions() : int
Inherited

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

Returns

int

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

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

Returns

string

Get message encoding method

getEncodingMethod() : int
Inherited

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

Returns

int

Return a list of available functions

getFunctions() : array
Inherited

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

Exceptions

\Zend\Soap\Exception\UnexpectedValueException

Returns

array

Retrieve HTTP Login

getHttpLogin() : string
Inherited

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

Returns

string

Retrieve HTTP Password

getHttpPassword() : string
Inherited

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

Returns

string

Get HTTPS client certificate passphrase

getHttpsCertPassphrase() : string
Inherited

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

Returns

string

Get HTTPS client certificate path

getHttpsCertificate() : string
Inherited

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

Returns

string

Retrieve last invoked method

getLastMethod() : string
Inherited

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

Returns

string

Retrieve request XML

getLastRequest() : string
Inherited

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

Returns

string

Retrieve request headers.

getLastRequestHeaders() : string

Returns

stringRequest headers.

Get response XML

getLastResponse() : string
Inherited

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

Returns

string

Retrieve response headers (as string)

getLastResponseHeaders() : string

Returns

stringResponse headers.

Get last SOAP output headers

getLastSoapOutputHeaderObjects() : array
Inherited

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

Returns

array

Retrieve URI

getLocation() : string
Inherited

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

Returns

string

Return array of options suitable for using with SoapClient constructor

getOptions() : array
Inherited

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

Returns

array

Retrieve proxy host

getProxyHost() : string
Inherited

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

Returns

string

Retrieve proxy login

getProxyLogin() : string
Inherited

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

Returns

string

Retrieve proxy password

getProxyPassword() : string
Inherited

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

Returns

string

Retrieve proxy port

getProxyPort() : int
Inherited

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

Returns

int

Get SoapClient object

getSoapClient() : \SoapClient
Inherited

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

Returns

\SoapClient

Return current SOAP Features options

getSoapFeatures() : int
Inherited

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

Returns

int

Get SOAP version

getSoapVersion() : int
Inherited

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

Returns

int

Get Stream Context

getStreamContext() : resource
Inherited

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

Returns

resource

Get request style

getStyle() : int
Inherited

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

Returns

int

Retrieve typemap

getTypemap() : array
Inherited

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

Returns

array

Return a list of SOAP types

getTypes() : array
Inherited

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

Exceptions

\Zend\Soap\Exception\UnexpectedValueException

Returns

array

Retrieve URI

getUri() : string
Inherited

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

Returns

string

Get current string to use in User-Agent header

getUserAgent() : string | null
Inherited

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

Returns

stringnull

Get wsdl

getWSDL() : string
Inherited

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

Returns

string

Get current SOAP WSDL Caching option

getWSDLCache() : int
Inherited

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

Returns

int

Reset SOAP input headers

resetSoapInputHeaders() : \Zend\Soap\self
Inherited

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

Returns

\Zend\Soap\self

Set classmap

setClassmap(array $classmap) : \Zend\Soap\self
Inherited

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

Parameters

$classmap

array

Exceptions

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

Returns

\Zend\Soap\self

Set compression options

setCompressionOptions(int | null $compressionOptions) : \Zend\Soap\self
Inherited

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

Parameters

$compressionOptions

intnull

Returns

\Zend\Soap\self

Set cookie

setCookie(string $cookieName, string $cookieValue) : \Zend\Soap\self
Inherited

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

Parameters

$cookieName

string

$cookieValue

string

Returns

\Zend\Soap\self

Sets the cURL client to use.

setCurlClient(\Zend\Http\Client\Adapter\Curl $curlClient) : \Zend\Soap\Client\self

Parameters

$curlClient

\Zend\Http\Client\Adapter\Curl

The cURL client.

Returns

\Zend\Soap\Client\self

Set encoding

setEncoding(string $encoding) : \Zend\Soap\self
Inherited

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

Parameters

$encoding

string

Exceptions

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

Returns

\Zend\Soap\self

Set message encoding method

setEncodingMethod(int $use) : \Zend\Soap\self
Inherited

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

Parameters

$use

int

One of the SOAP_ENCODED or SOAP_LITERAL constants

Exceptions

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

Returns

\Zend\Soap\self

Set HTTP login

setHttpLogin(string $login) : \Zend\Soap\self
Inherited

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

Parameters

$login

string

Returns

\Zend\Soap\self

Set HTTP password

setHttpPassword(string $password) : \Zend\Soap\self
Inherited

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

Parameters

$password

string

Returns

\Zend\Soap\self

Set HTTPS client certificate passphrase

setHttpsCertPassphrase(string $passphrase) : \Zend\Soap\self
Inherited

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

Parameters

$passphrase

string

Returns

\Zend\Soap\self

Set HTTPS client certificate path

setHttpsCertificate(string $localCert) : \Zend\Soap\self
Inherited

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

Parameters

$localCert

string

local certificate path

Exceptions

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

Returns

\Zend\Soap\self

Set Location

setLocation(string $location) : \Zend\Soap\self
Inherited

URI in Web Service the target namespace

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

Parameters

$location

string

Exceptions

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

Returns

\Zend\Soap\self

Sets options.

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

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

Parameters

$options

array\Traversable

Options.

Exceptions

\InvalidArgumentException If an unsupported option is passed.

Returns

\Zend\Soap\Client\self

Set proxy host

setProxyHost(string $proxyHost) : \Zend\Soap\self
Inherited

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

Parameters

$proxyHost

string

Returns

\Zend\Soap\self

Set proxy login

setProxyLogin(string $proxyLogin) : \Zend\Soap\self
Inherited

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

Parameters

$proxyLogin

string

Returns

\Zend\Soap\self

Set proxy password

setProxyPassword(string $proxyPassword) : \Zend\Soap\self
Inherited

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

Parameters

$proxyPassword

string

Returns

\Zend\Soap\self

Set proxy port

setProxyPort(int $proxyPort) : \Zend\Soap\self
Inherited

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

Parameters

$proxyPort

int

Returns

\Zend\Soap\self

Set SoapClient object

setSoapClient(\SoapClient $soapClient) : \Zend\Soap\self
Inherited

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

Parameters

$soapClient

\SoapClient

Returns

\Zend\Soap\self

Set the SOAP Feature options.

setSoapFeatures(string | int $feature) : \Zend\Soap\self
Inherited

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

Parameters

$feature

stringint

Returns

\Zend\Soap\self

Set SOAP version

setSoapVersion(int $version) : \Zend\Soap\self
Inherited

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

Parameters

$version

int

One of the SOAP_1_1 or SOAP_1_2 constants

Exceptions

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

Returns

\Zend\Soap\self

Set Stream Context

setStreamContext(resource $context) : \Zend\Soap\self
Inherited

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

Parameters

$context

resource

Exceptions

\Zend\Soap\Exception\InvalidArgumentException

Returns

\Zend\Soap\self

Set request style

setStyle(int $style) : \Zend\Soap\self
Inherited

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

Parameters

$style

int

One of the SOAP_RPC or SOAP_DOCUMENT constants

Exceptions

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

Returns

\Zend\Soap\self

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

setTypemap(array $typeMap) : \Zend\Soap\self
Inherited

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

Parameters

$typeMap

array

Exceptions

\Zend\Soap\Exception\InvalidArgumentException

Returns

\Zend\Soap\self

Set URI

setUri(string $uri) : \Zend\Soap\self
Inherited

URI in Web Service the target namespace

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

Parameters

$uri

string

Exceptions

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

Returns

\Zend\Soap\self

Set the string to use in User-Agent header

setUserAgent(string | null $userAgent) : \Zend\Soap\self
Inherited

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

Parameters

$userAgent

stringnull

Returns

\Zend\Soap\self

Set wsdl

setWSDL(string $wsdl) : \Zend\Soap\self
Inherited

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

Parameters

$wsdl

string

Returns

\Zend\Soap\self

Set the SOAP WSDL Caching Options

setWSDLCache(string | int | bool | null $caching) : \Zend\Soap\self
Inherited

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

Parameters

$caching

stringintboolnull

Returns

\Zend\Soap\self

Check for valid URN

validateUrn(string $urn) : bool
Inherited

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

Parameters

$urn

string

Exceptions

\Zend\Soap\Exception\InvalidArgumentException on invalid URN

Returns

bool

Initialize SOAP Client object

_initSoapClientObject() 
Inherited

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

Exceptions

\Zend\Soap\Exception\ExceptionInterface

Perform arguments pre-processing

_preProcessArguments(array $arguments) : array

My be overridden in descendant classes

Parameters

$arguments

array

Exceptions

\Zend\Soap\Exception\RuntimeException

Returns

array

Perform result pre-processing

_preProcessResult(object $result) : mixed

My be overridden in descendant classes

Parameters

$result

object

Returns

mixed

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 
Inherited

inherited_from \Zend\Soap\Client::$$cacheWsdl
 

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

$classmap : array
Inherited

inherited_from \Zend\Soap\Client::$$classmap
 

$compression

$compression 
Inherited

inherited_from \Zend\Soap\Client::$$compression
 

$connectionTimeout

$connectionTimeout 
Inherited

inherited_from \Zend\Soap\Client::$$connectionTimeout
 

Curl HTTP client adapter.

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

 

Encoding

$encoding : string
Inherited

inherited_from \Zend\Soap\Client::$$encoding
 

Registered fault exceptions

$faultExceptions : array
Inherited

inherited_from \Zend\Soap\Client::$$faultExceptions
 

$features

$features 
Inherited

inherited_from \Zend\Soap\Client::$$features
 

Last invoked method

$lastMethod : string
Inherited

inherited_from \Zend\Soap\Client::$$lastMethod
 

The last request headers.

$lastRequestHeaders : string

 

The last response headers.

$lastResponseHeaders : string

 

$localCert

$localCert 
Inherited

inherited_from \Zend\Soap\Client::$$localCert
 

$location

$location 
Inherited

inherited_from \Zend\Soap\Client::$$location
 

$login

$login 
Inherited

inherited_from \Zend\Soap\Client::$$login
 

SOAP client options.

$options : array

 

$passphrase

$passphrase 
Inherited

inherited_from \Zend\Soap\Client::$$passphrase
 

$password

$password 
Inherited

inherited_from \Zend\Soap\Client::$$password
 

Permanent SOAP request headers (shared between requests).

$permanentSoapInputHeaders : array
Inherited

inherited_from \Zend\Soap\Client::$$permanentSoapInputHeaders
 

$proxyHost

$proxyHost 
Inherited

inherited_from \Zend\Soap\Client::$$proxyHost
 

$proxyLogin

$proxyLogin 
Inherited

inherited_from \Zend\Soap\Client::$$proxyLogin
 

$proxyPassword

$proxyPassword 
Inherited

inherited_from \Zend\Soap\Client::$$proxyPassword
 

$proxyPort

$proxyPort 
Inherited

inherited_from \Zend\Soap\Client::$$proxyPort
 

SoapClient object

$soapClient : \SoapClient
Inherited

inherited_from \Zend\Soap\Client::$$soapClient
 

Array of SoapHeader objects

$soapInputHeaders : \SoapHeader[]
Inherited

inherited_from \Zend\Soap\Client::$$soapInputHeaders
 

Array of SoapHeader objects

$soapOutputHeaders : array
Inherited

inherited_from \Zend\Soap\Client::$$soapOutputHeaders
 

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

$soapVersion : int
Inherited

inherited_from \Zend\Soap\Client::$$soapVersion
 

$streamContext

$streamContext 
Inherited

inherited_from \Zend\Soap\Client::$$streamContext
 

$style

$style 
Inherited

inherited_from \Zend\Soap\Client::$$style
 

$typemap

$typemap : array
Inherited

inherited_from \Zend\Soap\Client::$$typemap
 

$uri

$uri 
Inherited

inherited_from \Zend\Soap\Client::$$uri
 

$use

$use 
Inherited

inherited_from \Zend\Soap\Client::$$use
 

Should NTLM authentication be used?

$useNtlm : boolean

 

$userAgent

$userAgent 
Inherited

inherited_from \Zend\Soap\Client::$$userAgent
 

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

$wsdl : string
Inherited

inherited_from \Zend\Soap\Client::$$wsdl