Zend Framework
Back to top  

 Methods

Perform a SOAP call

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

Parameters

$name

string

$arguments

array

Returns

mixed

__construct() 

__construct(string $wsdl, array | \Traversable $options) 

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, int $version, int $oneWay) : mixed

May be overridden in subclasses

Parameters

$client

\Zend\Soap\Client\Common

$request

string

$location

string

$action

string

$version

int

$oneWay

int

Returns

mixed

Add SOAP input header

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

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

Unified interface for calling custom remote methods.

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

Returns

mixed

Get Compression options

getCompressionOptions() : int

Returns

int

Get encoding

getEncoding() : string

Returns

string

Get message encoding method

getEncodingMethod() : int

Returns

int

Return a list of available functions

getFunctions() : array

Exceptions

\Zend\Soap\Exception\UnexpectedValueException

Returns

array

Retrieve HTTP Login

getHttpLogin() : string

Returns

string

Retrieve HTTP Password

getHttpPassword() : string

Returns

string

Get HTTPS client certificate passphrase

getHttpsCertPassphrase() : string

Returns

string

Get HTTPS client certificate path

getHttpsCertificate() : string

Returns

string

Retrieve last invoked method

getLastMethod() : string

Returns

string

Retrieve request XML

getLastRequest() : string

Returns

string

Retrieve request headers

getLastRequestHeaders() : string

Returns

string

Get response XML

getLastResponse() : string

Returns

string

Retrieve response headers (as string)

getLastResponseHeaders() : string

Returns

string

Get last SOAP output headers

getLastSoapOutputHeaderObjects() : array

Returns

array

Retrieve URI

getLocation() : string

Returns

string

Return array of options suitable for using with SoapClient constructor

getOptions() : array

Returns

array

Retrieve proxy host

getProxyHost() : string

Returns

string

Retrieve proxy login

getProxyLogin() : string

Returns

string

Retrieve proxy password

getProxyPassword() : string

Returns

string

Retrieve proxy port

getProxyPort() : int

Returns

int

Get SoapClient object

getSoapClient() : \SoapClient

Returns

\SoapClient

Return current SOAP Features options

getSoapFeatures() : int

Returns

int

Get SOAP version

getSoapVersion() : int

Returns

int

Get Stream Context

getStreamContext() : resource

Returns

resource

Get request style

getStyle() : int

Returns

int

Retrieve typemap

getTypemap() : array

Returns

array

Return a list of SOAP types

getTypes() : array

Exceptions

\Zend\Soap\Exception\UnexpectedValueException

Returns

array

Retrieve URI

getUri() : string

Returns

string

Get current string to use in User-Agent header

getUserAgent() : string | null

Returns

stringnull

Get wsdl

getWSDL() : string

Returns

string

Get current SOAP WSDL Caching option

getWSDLCache() : int

Returns

int

Reset SOAP input headers

resetSoapInputHeaders() : \Zend\Soap\self

Returns

\Zend\Soap\self

Set classmap

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

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

Parameters

$compressionOptions

intnull

Returns

\Zend\Soap\self

Set cookie

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

Parameters

$cookieName

string

$cookieValue

string

Returns

\Zend\Soap\self

Set encoding

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

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

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

Parameters

$login

string

Returns

\Zend\Soap\self

Set HTTP password

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

Parameters

$password

string

Returns

\Zend\Soap\self

Set HTTPS client certificate passphrase

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

Parameters

$passphrase

string

Returns

\Zend\Soap\self

Set HTTPS client certificate path

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

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

URI in Web Service the target namespace

Parameters

$location

string

Exceptions

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

Returns

\Zend\Soap\self

Set Options

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

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

Parameters

$options

array\Traversable

Exceptions

\Zend\Soap\Exception\InvalidArgumentException

Returns

\Zend\Soap\self

Set proxy host

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

Parameters

$proxyHost

string

Returns

\Zend\Soap\self

Set proxy login

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

Parameters

$proxyLogin

string

Returns

\Zend\Soap\self

Set proxy password

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

Parameters

$proxyPassword

string

Returns

\Zend\Soap\self

Set proxy port

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

Parameters

$proxyPort

int

Returns

\Zend\Soap\self

Set SoapClient object

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

Parameters

$soapClient

\SoapClient

Returns

\Zend\Soap\self

Set the SOAP Feature options.

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

Parameters

$feature

stringint

Returns

\Zend\Soap\self

Set SOAP version

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

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

Parameters

$context

resource

Exceptions

\Zend\Soap\Exception\InvalidArgumentException

Returns

\Zend\Soap\self

Set request style

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

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

Parameters

$typeMap

array

Exceptions

\Zend\Soap\Exception\InvalidArgumentException

Returns

\Zend\Soap\self

Set URI

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

URI in Web Service the target namespace

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

Parameters

$userAgent

stringnull

Returns

\Zend\Soap\self

Set wsdl

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

Parameters

$wsdl

string

Returns

\Zend\Soap\self

Set the SOAP WSDL Caching Options

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

Parameters

$caching

stringintboolnull

Returns

\Zend\Soap\self

Check for valid URN

validateUrn(string $urn) : bool

Parameters

$urn

string

Exceptions

\Zend\Soap\Exception\InvalidArgumentException on invalid URN

Returns

bool

Initialize SOAP Client object

_initSoapClientObject() 

Exceptions

\Zend\Soap\Exception\ExceptionInterface

Perform arguments pre-processing

_preProcessArguments(array $arguments) : array

My be overridden in descendant classes

Parameters

$arguments

array

Returns

array

Perform result pre-processing

_preProcessResult(array $result) : array

My be overridden in descendant classes

Parameters

$result

array

Returns

array

 Properties

 

$cacheWsdl

$cacheWsdl 

 

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

$classmap : array

 

$compression

$compression 

 

$connectionTimeout

$connectionTimeout 

 

Encoding

$encoding : string

 

Registered fault exceptions

$faultExceptions : array

 

$features

$features 

 

Last invoked method

$lastMethod : string

 

$localCert

$localCert 

 

$location

$location 

 

$login

$login 

 

$passphrase

$passphrase 

 

$password

$password 

 

Permanent SOAP request headers (shared between requests).

$permanentSoapInputHeaders : array

 

$proxyHost

$proxyHost 

 

$proxyLogin

$proxyLogin 

 

$proxyPassword

$proxyPassword 

 

$proxyPort

$proxyPort 

 

SoapClient object

$soapClient : \SoapClient

 

Array of SoapHeader objects

$soapInputHeaders : \SoapHeader[]

 

Array of SoapHeader objects

$soapOutputHeaders : array

 

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

$soapVersion : int

 

$streamContext

$streamContext 

 

$style

$style 

 

$typemap

$typemap : array

 

$uri

$uri 

 

$use

$use 

 

$userAgent

$userAgent 

 

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

$wsdl : string