Fully Qualified Name: | Laminas\Soap\Client\Local |
Extends: | Client |
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.
Name | Description | Defined By |
---|---|---|
__call() | Perform a SOAP call | Client |
__construct() | Local client constructor | Local |
_doRequest() | Actual "do request" method. | Local |
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 |
Perform a SOAP call
Parameter Name | Type | Description |
---|---|---|
$name | string | |
$arguments | array |
Returns: mixed
Local client constructor
Parameter Name | Type | Description |
---|---|---|
$server | \SOAPServer | |
$wsdl | string | |
$options | array |
Returns:
Actual "do request" method.
Parameter Name | Type | Description |
---|---|---|
$client | \Common | |
$request | string | |
$location | string | |
$action | string | |
$version | int | |
$oneWay | int |
Returns: mixed
Add SOAP input header
Parameter Name | Type | Description |
---|---|---|
$header | \SoapHeader | |
$permanent | bool |
Returns: self
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.
Retrieve classmap
Returns: mixed
Get Compression options
Returns: int
Get encoding
Returns: string
Get message encoding method
Returns: int
Return a list of available functions
Returns: array
Retrieve HTTP Login
Returns: string
Retrieve HTTP Password
Returns: string
Get HTTPS client certificate passphrase
Returns: string
Get HTTPS client certificate path
Returns: string
Returns: bool
Retrieve last invoked method
Returns: string
Retrieve request XML
Returns: string
Retrieve request headers
Returns: string
Get response XML
Returns: string
Retrieve response headers (as string)
Returns: string
Get last SOAP output headers
Returns: array
Retrieve URI
Returns: string
Return array of options suitable for using with SoapClient constructor
Returns: array
Retrieve proxy host
Returns: string
Retrieve proxy login
Returns: string
Retrieve proxy password
Returns: string
Retrieve proxy port
Returns: int
Get SoapClient object
Returns: \SoapClient
Return current SOAP Features options
Returns: int
Get SOAP version
Returns: int
Returns: int
Get Stream Context
Returns: resource
Get request style
Returns: int
Retrieve typemap
Returns: array
Return a list of SOAP types
Returns: array
Retrieve URI
Returns: string
Get current string to use in User-Agent header
Returns: string|null
Get wsdl
Returns: string
Get current SOAP WSDL Caching option
Returns: int
Reset SOAP input headers
Returns: self
Set classmap
Parameter Name | Type | Description |
---|---|---|
$classmap | array |
Returns: self
Set compression options
Parameter Name | Type | Description |
---|---|---|
$compressionOptions | int|null |
Returns: self
Set cookie
Parameter Name | Type | Description |
---|---|---|
$cookieName | string | |
$cookieValue | string |
Returns: self
Set encoding
Parameter Name | Type | Description |
---|---|---|
$encoding | string |
Returns: self
Set message encoding method
Parameter Name | Type | Description |
---|---|---|
$use | int | One |
Returns: self
Set HTTP login
Parameter Name | Type | Description |
---|---|---|
$login | string |
Returns: self
Set HTTP password
Parameter Name | Type | Description |
---|---|---|
$password | string |
Returns: self
Set HTTPS client certificate passphrase
Parameter Name | Type | Description |
---|---|---|
$passphrase | string |
Returns: self
Set HTTPS client certificate path
Parameter Name | Type | Description |
---|---|---|
$localCert | string | local |
Returns: self
Parameter Name | Type | Description |
---|---|---|
$keepAlive | bool |
Returns: self
Set Location
URI in Web Service the target namespace
Parameter Name | Type | Description |
---|---|---|
$location | string |
Returns: self
Set Options
Allows setting options as an associative array of option => value pairs.
Parameter Name | Type | Description |
---|---|---|
$options | array|\Traversable |
Returns: self
Set proxy host
Parameter Name | Type | Description |
---|---|---|
$proxyHost | string |
Returns: self
Set proxy login
Parameter Name | Type | Description |
---|---|---|
$proxyLogin | string |
Returns: self
Set proxy password
Parameter Name | Type | Description |
---|---|---|
$proxyPassword | string |
Returns: self
Set proxy port
Parameter Name | Type | Description |
---|---|---|
$proxyPort | int |
Returns: self
Set SoapClient object
Parameter Name | Type | Description |
---|---|---|
$soapClient | \SoapClient |
Returns: self
Set the SOAP Feature options.
Parameter Name | Type | Description |
---|---|---|
$feature | string|int |
Returns: self
Set SOAP version
Parameter Name | Type | Description |
---|---|---|
$version | int | One |
Returns: self
Parameter Name | Type | Description |
---|---|---|
$sslMethod | int |
Returns: self
Set Stream Context
Parameter Name | Type | Description |
---|---|---|
$context | resource |
Returns: self
Set request style
Parameter Name | Type | Description |
---|---|---|
$style | int | One |
Returns: self
Set typemap with xml to php type mappings with appropriate validation.
Parameter Name | Type | Description |
---|---|---|
$typeMap | array |
Returns: self
Set URI
URI in Web Service the target namespace
Parameter Name | Type | Description |
---|---|---|
$uri | string |
Returns: self
Set the string to use in User-Agent header
Parameter Name | Type | Description |
---|---|---|
$userAgent | string|null |
Returns: self
Set wsdl
Parameter Name | Type | Description |
---|---|---|
$wsdl | string |
Returns: self
Set the SOAP WSDL Caching Options
Parameter Name | Type | Description |
---|---|---|
$caching | string|int|bool|null |
Returns: self
Check for valid URN
Parameter Name | Type | Description |
---|---|---|
$urn | string |
Returns: bool