1743. Class

1743.1. Zend\Soap\Client

ZendSoapClient

1743.1.1. Methods

1743.1.1.1. __construct

__construct()

Constructor

Parameters:
  • string
  • array|Traversable
Throws ExceptionExtensionNotLoadedException:
 

1743.1.1.2. setWSDL

setWSDL()

Set wsdl

Parameters:string
Return type:Client

1743.1.1.3. getWSDL

getWSDL()

Get wsdl

Return type:string

1743.1.1.4. setOptions

setOptions()

Set Options

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

Parameters:array|Traversable
Return type:Client
Throws :ExceptionInvalidArgumentException

1743.1.1.5. getOptions

getOptions()

Return array of options suitable for using with SoapClient constructor

Return type:array

1743.1.1.6. setSoapVersion

setSoapVersion()

Set SOAP version

Parameters:int – One of the SOAP_1_1 or SOAP_1_2 constants
Return type:Client
Throws :ExceptionInvalidArgumentException with invalid soap version argument

1743.1.1.7. getSoapVersion

getSoapVersion()

Get SOAP version

Return type:int

1743.1.1.8. setClassmap

setClassmap()

Set classmap

Parameters:array
Return type:Client
Throws :ExceptionInvalidArgumentException for any invalid class in the class map

1743.1.1.9. getClassmap

getClassmap()

Retrieve classmap

Return type:mixed

1743.1.1.10. setEncoding

setEncoding()

Set encoding

Parameters:string
Return type:Client
Throws :ExceptionInvalidArgumentException with invalid encoding argument

1743.1.1.11. getEncoding

getEncoding()

Get encoding

Return type:string

1743.1.1.12. validateUrn

validateUrn()

Check for valid URN

Parameters:string
Return type:bool
Throws :ExceptionInvalidArgumentException on invalid URN

1743.1.1.13. setUri

setUri()

Set URI

URI in Web Service the target namespace

Parameters:string
Return type:Client
Throws :ExceptionExceptionInterface with invalid uri argument

1743.1.1.14. getUri

getUri()

Retrieve URI

Return type:string

1743.1.1.15. setLocation

setLocation()

Set Location

URI in Web Service the target namespace

Parameters:string
Return type:Client
Throws :ExceptionExceptionInterface with invalid uri argument

1743.1.1.16. getLocation

getLocation()

Retrieve URI

Return type:string

1743.1.1.17. setStyle

setStyle()

Set request style

Parameters:int – One of the SOAP_RPC or SOAP_DOCUMENT constants
Return type:Client
Throws :ExceptionInvalidArgumentException with invalid style argument

1743.1.1.18. getStyle

getStyle()

Get request style

Return type:int

1743.1.1.19. setEncodingMethod

setEncodingMethod()

Set message encoding method

Parameters:int – One of the SOAP_ENCODED or SOAP_LITERAL constants
Return type:Client
Throws :ExceptionInvalidArgumentException with invalid message encoding method argument

1743.1.1.20. getEncodingMethod

getEncodingMethod()

Get message encoding method

Return type:int

1743.1.1.21. setHttpLogin

setHttpLogin()

Set HTTP login

Parameters:string
Return type:Client

1743.1.1.22. getHttpLogin

getHttpLogin()

Retrieve HTTP Login

Return type:string

1743.1.1.23. setHttpPassword

setHttpPassword()

Set HTTP password

Parameters:string
Return type:Client

1743.1.1.24. getHttpPassword

getHttpPassword()

Retrieve HTTP Password

Return type:string

1743.1.1.25. setProxyHost

setProxyHost()

Set proxy host

Parameters:string
Return type:Client

1743.1.1.26. getProxyHost

getProxyHost()

Retrieve proxy host

Return type:string

1743.1.1.27. setProxyPort

setProxyPort()

Set proxy port

Parameters:int
Return type:Client

1743.1.1.28. getProxyPort

getProxyPort()

Retrieve proxy port

Return type:int

1743.1.1.29. setProxyLogin

setProxyLogin()

Set proxy login

Parameters:string
Return type:Client

1743.1.1.30. getProxyLogin

getProxyLogin()

Retrieve proxy login

Return type:string

1743.1.1.31. setProxyPassword

setProxyPassword()

Set proxy password

Parameters:string
Return type:Client

1743.1.1.32. setHttpsCertificate

setHttpsCertificate()

Set HTTPS client certificate path

Parameters:string – local certificate path
Return type:Client
Throws :ExceptionInvalidArgumentException with invalid local certificate path argument

1743.1.1.33. getHttpsCertificate

getHttpsCertificate()

Get HTTPS client certificate path

Return type:string

1743.1.1.34. setHttpsCertPassphrase

setHttpsCertPassphrase()

Set HTTPS client certificate passphrase

Parameters:string
Return type:Client

1743.1.1.35. getHttpsCertPassphrase

getHttpsCertPassphrase()

Get HTTPS client certificate passphrase

Return type:string

1743.1.1.36. setCompressionOptions

setCompressionOptions()

Set compression options

Parameters:int|null
Return type:Client

1743.1.1.37. getCompressionOptions

getCompressionOptions()

Get Compression options

Return type:int

1743.1.1.38. getProxyPassword

getProxyPassword()

Retrieve proxy password

Return type:string

1743.1.1.39. setStreamContext

setStreamContext()

Set Stream Context

Parameters:resource
Return type:Client
Throws :ExceptionInvalidArgumentException if $context is not a valid stream resource

1743.1.1.40. getStreamContext

getStreamContext()

Get Stream Context

Return type:resource

1743.1.1.41. setSoapFeatures

setSoapFeatures()

Set the SOAP Feature options.

Parameters:string|int
Return type:Client

1743.1.1.42. getSoapFeatures

getSoapFeatures()

Return current SOAP Features options

Return type:int

1743.1.1.43. setWSDLCache

setWSDLCache()

Set the SOAP WSDL Caching Options

Parameters:string|int|bool|null
Return type:Client

1743.1.1.44. getWSDLCache

getWSDLCache()

Get current SOAP WSDL Caching option

Return type:int

1743.1.1.45. setUserAgent

setUserAgent()

Set the string to use in User-Agent header

Parameters:string|null
Return type:Client

1743.1.1.46. getUserAgent

getUserAgent()

Get current string to use in User-Agent header

Return type:string|null

1743.1.1.47. getLastRequest

getLastRequest()

Retrieve request XML

Return type:string

1743.1.1.48. getLastResponse

getLastResponse()

Get response XML

Return type:string

1743.1.1.49. getLastRequestHeaders

getLastRequestHeaders()

Retrieve request headers

Return type:string

1743.1.1.50. getLastResponseHeaders

getLastResponseHeaders()

Retrieve response headers (as string)

Return type:string

1743.1.1.51. getLastMethod

getLastMethod()

Retrieve last invoked method

Return type:string

1743.1.1.52. _doRequest

_doRequest()

Do request proxy method.

May be overridden in subclasses

Parameters:
  • ClientCommon
  • string
  • string
  • string
  • int
  • int
Return type:

mixed

1743.1.1.53. _initSoapClientObject

_initSoapClientObject()

Initialize SOAP Client object

1743.1.1.54. _preProcessArguments

_preProcessArguments()

Perform arguments pre-processing

My be overridden in descendant classes

Parameters:array
Return type:array

1743.1.1.55. _preProcessResult

_preProcessResult()

Perform result pre-processing

My be overridden in descendant classes

Parameters:array
Return type:array

1743.1.1.56. addSoapInputHeader

addSoapInputHeader()

Add SOAP input header

Parameters:
  • SoapHeader
  • bool
Return type:

Client

1743.1.1.57. resetSoapInputHeaders

resetSoapInputHeaders()

Reset SOAP input headers

Return type:Client

1743.1.1.58. getLastSoapOutputHeaderObjects

getLastSoapOutputHeaderObjects()

Get last SOAP output headers

Return type:array

1743.1.1.59. __call

__call()

Perform a SOAP call

Parameters:
  • string
  • array
Return type:

mixed

1743.1.1.60. call

call()

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

Parameters:
  • string – Name of the method we want to call.
  • array – List of parameters for the method.
Return type:

mixed Returned results.

1743.1.1.61. getFunctions

getFunctions()

Return a list of available functions

Return type:array
Throws :ExceptionUnexpectedValueException

1743.1.1.62. getTypes

getTypes()

Return a list of SOAP types

Return type:array
Throws :ExceptionUnexpectedValueException

1743.1.1.63. setSoapClient

setSoapClient()

@param SoapClient $soapClient

Return type:Client

1743.1.1.64. getSoapClient

getSoapClient()

@return SoapClient

1743.1.1.65. setCookie

setCookie()

@param string $cookieName

Parameters:string
Return type:Client

Project Versions

Table Of Contents

Previous topic

1742. Class

Next topic

1744. Class

This Page