Summary

Fully Qualified Name:	Laminas\Soap\Client
Implements:	Client

Description

Methods

Name	Description	Defined By
__call()	Perform a SOAP call	Client
__construct()		Client
_doRequest()	Do request proxy method.	Client
addSoapInputHeader()	Add SOAP input header	Client
call()	Send an RPC request to the service for a specific method.	Client
getClassmap()	Retrieve classmap	Client
getCompressionOptions()	Get Compression options	Client
getEncoding()	Get encoding	Client
getEncodingMethod()	Get message encoding method	Client
getFunctions()	Return a list of available functions	Client
getHttpLogin()	Retrieve HTTP Login	Client
getHttpPassword()	Retrieve HTTP Password	Client
getHttpsCertPassphrase()	Get HTTPS client certificate passphrase	Client
getHttpsCertificate()	Get HTTPS client certificate path	Client
getKeepAlive()		Client
getLastMethod()	Retrieve last invoked method	Client
getLastRequest()	Retrieve request XML	Client
getLastRequestHeaders()	Retrieve request headers	Client
getLastResponse()	Get response XML	Client
getLastResponseHeaders()	Retrieve response headers (as string)	Client
getLastSoapOutputHeaderObjects()	Get last SOAP output headers	Client
getLocation()	Retrieve URI	Client
getOptions()	Return array of options suitable for using with SoapClient constructor	Client
getProxyHost()	Retrieve proxy host	Client
getProxyLogin()	Retrieve proxy login	Client
getProxyPassword()	Retrieve proxy password	Client
getProxyPort()	Retrieve proxy port	Client
getSoapClient()	Get SoapClient object	Client
getSoapFeatures()	Return current SOAP Features options	Client
getSoapVersion()	Get SOAP version	Client
getSslMethod()		Client
getStreamContext()	Get Stream Context	Client
getStyle()	Get request style	Client
getTypemap()	Retrieve typemap	Client
getTypes()	Return a list of SOAP types	Client
getUri()	Retrieve URI	Client
getUserAgent()	Get current string to use in User-Agent header	Client
getWSDL()	Get wsdl	Client
getWSDLCache()	Get current SOAP WSDL Caching option	Client
resetSoapInputHeaders()	Reset SOAP input headers	Client
setClassmap()	Set classmap	Client
setCompressionOptions()	Set compression options	Client
setCookie()	Set cookie	Client
setEncoding()	Set encoding	Client
setEncodingMethod()	Set message encoding method	Client
setHttpLogin()	Set HTTP login	Client
setHttpPassword()	Set HTTP password	Client
setHttpsCertPassphrase()	Set HTTPS client certificate passphrase	Client
setHttpsCertificate()	Set HTTPS client certificate path	Client
setKeepAlive()		Client
setLocation()	Set Location	Client
setOptions()	Set Options	Client
setProxyHost()	Set proxy host	Client
setProxyLogin()	Set proxy login	Client
setProxyPassword()	Set proxy password	Client
setProxyPort()	Set proxy port	Client
setSoapClient()	Set SoapClient object	Client
setSoapFeatures()	Set the SOAP Feature options.	Client
setSoapVersion()	Set SOAP version	Client
setSslMethod()		Client
setStreamContext()	Set Stream Context	Client
setStyle()	Set request style	Client
setTypemap()	Set typemap with xml to php type mappings with appropriate validation.	Client
setUri()	Set URI	Client
setUserAgent()	Set the string to use in User-Agent header	Client
setWSDL()	Set wsdl	Client
setWSDLCache()	Set the SOAP WSDL Caching Options	Client
validateUrn()	Check for valid URN	Client

Method Details

__call()

Perform a SOAP call

Parameter Name	Type	Description
$name	string
$arguments	array

Returns: mixed

__construct()

Parameter Name	Type	Description
$wsdl	string
$options	array|\Traversable

Returns:

_doRequest()

Do request proxy method.

May be overridden in subclasses

Parameter Name	Type	Description
$client	\Client\Common
$request	string
$location	string
$action	string
$version	int
$oneWay	int

Returns: mixed

addSoapInputHeader()

Add SOAP input header

Parameter Name	Type	Description
$header	\SoapHeader
$permanent	bool

Returns: self

call()

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

Parameter Name	Type	Description
$method	string	Name
$params	array	List

Returns: mixed Returned results.

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

getHttpLogin()

Retrieve HTTP Login

Returns: string

getHttpPassword()

Retrieve HTTP Password

Returns: string

getHttpsCertPassphrase()

Get HTTPS client certificate passphrase

Returns: string

getHttpsCertificate()

Get HTTPS client certificate path

Returns: string

getKeepAlive()

Returns: bool

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

Get SoapClient object

Returns: \SoapClient

getSoapFeatures()

Return current SOAP Features options

Returns: int

getSoapVersion()

Get SOAP version

Returns: int

getSslMethod()

Returns: int

getStreamContext()

Get Stream Context

Returns: resource

getStyle()

Get request style

Returns: int

getTypemap()

Retrieve typemap

Returns: array

getTypes()

Return a list of SOAP types

Returns: array

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: self

setClassmap()

Set classmap

Parameter Name	Type	Description
$classmap	array

Returns: self

setCompressionOptions()

Set compression options

Parameter Name	Type	Description
$compressionOptions	int|null

Returns: self

setCookie()

Set cookie

Parameter Name	Type	Description
$cookieName	string
$cookieValue	string

Returns: self

setEncoding()

Set encoding

Parameter Name	Type	Description
$encoding	string

Returns: self

setEncodingMethod()

Set message encoding method

Parameter Name	Type	Description
$use	int	One

Returns: self

setHttpLogin()

Set HTTP login

Parameter Name	Type	Description
$login	string

Returns: self

setHttpPassword()

Set HTTP password

Parameter Name	Type	Description
$password	string

Returns: self

setHttpsCertPassphrase()

Set HTTPS client certificate passphrase

Parameter Name	Type	Description
$passphrase	string

Returns: self

setHttpsCertificate()

Set HTTPS client certificate path

Parameter Name	Type	Description
$localCert	string	local

Returns: self

setKeepAlive()

Parameter Name	Type	Description
$keepAlive	bool

Returns: self

setLocation()

Set Location

URI in Web Service the target namespace

Parameter Name	Type	Description
$location	string

Returns: self

setOptions()

Set Options

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

Parameter Name	Type	Description
$options	array|\Traversable

Returns: self

setProxyHost()

Set proxy host

Parameter Name	Type	Description
$proxyHost	string

Returns: self

setProxyLogin()

Set proxy login

Parameter Name	Type	Description
$proxyLogin	string

Returns: self

setProxyPassword()

Set proxy password

Parameter Name	Type	Description
$proxyPassword	string

Returns: self

setProxyPort()

Set proxy port

Parameter Name	Type	Description
$proxyPort	int

Returns: self

setSoapClient()

Set SoapClient object

Parameter Name	Type	Description
$soapClient	\SoapClient

Returns: self

setSoapFeatures()

Set the SOAP Feature options.

Parameter Name	Type	Description
$feature	string|int

Returns: self

setSoapVersion()

Set SOAP version

Parameter Name	Type	Description
$version	int	One

Returns: self

setSslMethod()

Parameter Name	Type	Description
$sslMethod	int

Returns: self

setStreamContext()

Set Stream Context

Parameter Name	Type	Description
$context	resource

Returns: self

setStyle()

Set request style

Parameter Name	Type	Description
$style	int	One

Returns: self

setTypemap()

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

Parameter Name	Type	Description
$typeMap	array

Returns: self

setUri()

Set URI

URI in Web Service the target namespace

Parameter Name	Type	Description
$uri	string

Returns: self

setUserAgent()

Set the string to use in User-Agent header

Parameter Name	Type	Description
$userAgent	string|null

Returns: self

setWSDL()

Set wsdl

Parameter Name	Type	Description
$wsdl	string

Returns: self

setWSDLCache()

Set the SOAP WSDL Caching Options

Parameter Name	Type	Description
$caching	string|int|bool|null

Returns: self

validateUrn()

Check for valid URN

Parameter Name	Type	Description
$urn	string

Returns: bool