Soap/Client/Local.php

Show:

inherited

Classes
- \Zend_Soap_Client_Local

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Soap
Subpackage: Client
Version: $Id: Local.php 25033 2012-08-17 19:50:08Z matthew $

\Zend_Soap_Client_Local
jump to top

Package: Zend\Soap\Client

Zend_Soap_Client_Local

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.

Parent(s): \Zend_Soap_Client
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)

Properties

$_cache_wsdl = null

inheritedInherited from: \Zend_Soap_Client::$$_cache_wsdl

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Soap_Client::$$_cache_wsdl

array $_classmap = null

inherited

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

Inherited from: \Zend_Soap_Client::$$_classmap

Default valuenullDetails

Type: array
Inherited_from: \Zend_Soap_Client::$$_classmap

$_compression = null

inheritedInherited from: \Zend_Soap_Client::$$_compression

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Soap_Client::$$_compression

$_connection_timeout = null

inheritedInherited from: \Zend_Soap_Client::$$_connection_timeout

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Soap_Client::$$_connection_timeout

string $_encoding = 'UTF-8'

inherited

Encoding

Inherited from: \Zend_Soap_Client::$$_encoding

Default value'UTF-8'Details

Type: string
Inherited_from: \Zend_Soap_Client::$$_encoding

array $_faultExceptions = array()

inherited

Registered fault exceptions

Inherited from: \Zend_Soap_Client::$$_faultExceptions

Default valuearray()Details

Type: array
Inherited_from: \Zend_Soap_Client::$$_faultExceptions

$_features = null

inheritedInherited from: \Zend_Soap_Client::$$_features

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Soap_Client::$$_features

string $_lastMethod = ''

inherited

Last invoked method

Inherited from: \Zend_Soap_Client::$$_lastMethod

Default value''Details

Type: string
Inherited_from: \Zend_Soap_Client::$$_lastMethod

$_local_cert = null

inheritedInherited from: \Zend_Soap_Client::$$_local_cert

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Soap_Client::$$_local_cert

$_location = null

inheritedInherited from: \Zend_Soap_Client::$$_location

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Soap_Client::$$_location

$_login = null

inheritedInherited from: \Zend_Soap_Client::$$_login

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Soap_Client::$$_login

$_passphrase = null

inheritedInherited from: \Zend_Soap_Client::$$_passphrase

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Soap_Client::$$_passphrase

$_password = null

inheritedInherited from: \Zend_Soap_Client::$$_password

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Soap_Client::$$_password

array $_permanentSoapInputHeaders = array()

inherited

Permanent SOAP request headers (shared between requests).

Inherited from: \Zend_Soap_Client::$$_permanentSoapInputHeaders

Array of SoapHeader objects

Default valuearray()Details

Type: array
Inherited_from: \Zend_Soap_Client::$$_permanentSoapInputHeaders

$_proxy_host = null

inheritedInherited from: \Zend_Soap_Client::$$_proxy_host

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Soap_Client::$$_proxy_host

$_proxy_login = null

inheritedInherited from: \Zend_Soap_Client::$$_proxy_login

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Soap_Client::$$_proxy_login

$_proxy_password = null

inheritedInherited from: \Zend_Soap_Client::$$_proxy_password

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Soap_Client::$$_proxy_password

$_proxy_port = null

inheritedInherited from: \Zend_Soap_Client::$$_proxy_port

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Soap_Client::$$_proxy_port

\Zend_Soap_Server $_server

Server object

Details

Type: \Zend_Soap_Server

\SoapClient $_soapClient

inherited

SoapClient object

Inherited from: \Zend_Soap_Client::$$_soapClient

Details

Type: \SoapClient
Inherited_from: \Zend_Soap_Client::$$_soapClient

array $_soapInputHeaders = array()

inherited

SOAP request headers.

Inherited from: \Zend_Soap_Client::$$_soapInputHeaders

Array of SoapHeader objects

Default valuearray()Details

Type: array
Inherited_from: \Zend_Soap_Client::$$_soapInputHeaders

array $_soapOutputHeaders = array()

inherited

Output SOAP headers.

Inherited from: \Zend_Soap_Client::$$_soapOutputHeaders

Array of SoapHeader objects

Default valuearray()Details

Type: array
Inherited_from: \Zend_Soap_Client::$$_soapOutputHeaders

int $_soapVersion = SOAP_1_2

inherited

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

Inherited from: \Zend_Soap_Client::$$_soapVersion

Default valueSOAP_1_2Details

Type: int
Inherited_from: \Zend_Soap_Client::$$_soapVersion

$_stream_context = null

inheritedInherited from: \Zend_Soap_Client::$$_stream_context

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Soap_Client::$$_stream_context

$_style = null

inheritedInherited from: \Zend_Soap_Client::$$_style

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Soap_Client::$$_style

$_uri = null

inherited

Set of other SoapClient options

Inherited from: \Zend_Soap_Client::$$_uri

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Soap_Client::$$_uri

$_use = null

inheritedInherited from: \Zend_Soap_Client::$$_use

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Soap_Client::$$_use

$_user_agent = null

inheritedInherited from: \Zend_Soap_Client::$$_user_agent

Default valuenullDetails

Type: n/a
Inherited_from: \Zend_Soap_Client::$$_user_agent

string $_wsdl = null

inherited

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

Inherited from: \Zend_Soap_Client::$$_wsdl

Default valuenullDetails

Type: string
Inherited_from: \Zend_Soap_Client::$$_wsdl

Methods

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

inherited

Perform a SOAP call

Inherited from: \Zend_Soap_Client::__call()

Parameters

Name	Type	Description
$name	string
$arguments	array

Returns

Type	Description
mixed

__construct(\Zend_Soap_Server $server, string $wsdl, array $options = null) : void

Local client constructor

Parameters

Name	Type	Description
$server	\Zend_Soap_Server
$wsdl	string
$options	array

_initSoapClientObject() : void

inherited

Initialize SOAP Client object

Inherited from: \Zend_Soap_Client::_initSoapClientObject()

Throws

Exception	Description
\Zend_Soap_Client_Exception

_preProcessArguments(array $arguments) : void

inherited

Perform arguments pre-processing

Inherited from: \Zend_Soap_Client::_preProcessArguments()

My be overridden in descendant classes

Parameters

Name	Type	Description
$arguments	array

_preProcessResult( $result) : void

inherited

Perform result pre-processing

Inherited from: \Zend_Soap_Client::_preProcessResult()

My be overridden in descendant classes

Parameters

Name	Type	Description
$result

addSoapInputHeader(\SoapHeader $header, boolean $permanent = false) : \Zend_Soap_Client

inherited

Add SOAP input header

Inherited from: \Zend_Soap_Client::addSoapInputHeader()

Parameters

Name	Type	Description
$header	\SoapHeader
$permanent	boolean

Returns

Type	Description
\Zend_Soap_Client

getClassmap() : mixed

inherited

Retrieve classmap

Inherited from: \Zend_Soap_Client::getClassmap()

Returns

Type	Description
mixed

getCompressionOptions() : int

inherited

Get Compression options

Inherited from: \Zend_Soap_Client::getCompressionOptions()

Returns

Type	Description
int

getEncoding() : string

inherited

Get encoding

Inherited from: \Zend_Soap_Client::getEncoding()

Returns

Type	Description
string

getEncodingMethod() : int

inherited

Get message encoding method

Inherited from: \Zend_Soap_Client::getEncodingMethod()

Returns

Type	Description
int

getFunctions() : array

inherited

Return a list of available functions

Inherited from: \Zend_Soap_Client::getFunctions()

Returns

Type	Description
array

Throws

Exception	Description
\Zend_Soap_Client_Exception

getHttpLogin() : string

inherited

Retrieve HTTP Login

Inherited from: \Zend_Soap_Client::getHttpLogin()

Returns

Type	Description
string

getHttpPassword() : string

inherited

Retrieve HTTP Password

Inherited from: \Zend_Soap_Client::getHttpPassword()

Returns

Type	Description
string

getHttpsCertPassphrase() : string

inherited

Get HTTPS client certificate passphrase

Inherited from: \Zend_Soap_Client::getHttpsCertPassphrase()

Returns

Type	Description
string

getHttpsCertificate() : string

inherited

Get HTTPS client certificate path

Inherited from: \Zend_Soap_Client::getHttpsCertificate()

Returns

Type	Description
string

getLastMethod() : string

inherited

Retrieve last invoked method

Inherited from: \Zend_Soap_Client::getLastMethod()

Returns

Type	Description
string

getLastRequest() : string

inherited

Retrieve request XML

Inherited from: \Zend_Soap_Client::getLastRequest()

Returns

Type	Description
string

getLastRequestHeaders() : string

inherited

Retrieve request headers

Inherited from: \Zend_Soap_Client::getLastRequestHeaders()

Returns

Type	Description
string

getLastResponse() : string

inherited

Get response XML

Inherited from: \Zend_Soap_Client::getLastResponse()

Returns

Type	Description
string

getLastResponseHeaders() : string

inherited

Retrieve response headers (as string)

Inherited from: \Zend_Soap_Client::getLastResponseHeaders()

Returns

Type	Description
string

getLastSoapOutputHeaderObjects() : array

inherited

Get last SOAP output headers

Inherited from: \Zend_Soap_Client::getLastSoapOutputHeaderObjects()

Returns

Type	Description
array

getLocation() : string

inherited

Retrieve URI

Inherited from: \Zend_Soap_Client::getLocation()

Returns

Type	Description
string

getOptions() : array

inherited

Return array of options suitable for using with SoapClient constructor

Inherited from: \Zend_Soap_Client::getOptions()

Returns

Type	Description
array

getProxyHost() : string

inherited

Retrieve proxy host

Inherited from: \Zend_Soap_Client::getProxyHost()

Returns

Type	Description
string

getProxyLogin() : string

inherited

Retrieve proxy login

Inherited from: \Zend_Soap_Client::getProxyLogin()

Returns

Type	Description
string

getProxyPassword() : string

inherited

Retrieve proxy password

Inherited from: \Zend_Soap_Client::getProxyPassword()

Returns

Type	Description
string

getProxyPort() : int

inherited

Retrieve proxy port

Inherited from: \Zend_Soap_Client::getProxyPort()

Returns

Type	Description
int

getSoapClient() : \SoapClient

inherited

Inherited from: \Zend_Soap_Client::getSoapClient()

Returns

Type	Description
\SoapClient

getSoapFeatures() : int

inherited

Return current SOAP Features options

Inherited from: \Zend_Soap_Client::getSoapFeatures()

Returns

Type	Description
int

getSoapVersion() : int

inherited

Get SOAP version

Inherited from: \Zend_Soap_Client::getSoapVersion()

Returns

Type	Description
int

getStreamContext() : resource

inherited

Get Stream Context

Inherited from: \Zend_Soap_Client::getStreamContext()

Returns

Type	Description
resource

getStyle() : int

inherited

Get request style

Inherited from: \Zend_Soap_Client::getStyle()

Returns

Type	Description
int

getTypes() : array

inherited

Return a list of SOAP types

Inherited from: \Zend_Soap_Client::getTypes()

Returns

Type	Description
array

Throws

Exception	Description
\Zend_Soap_Client_Exception

getUri() : string

inherited

Retrieve URI

Inherited from: \Zend_Soap_Client::getUri()

Returns

Type	Description
string

getUserAgent() : string | null

inherited

Get current string to use in User-Agent header

Inherited from: \Zend_Soap_Client::getUserAgent()

Returns

Type	Description
string \| null

getWsdl() : string

inherited

Get wsdl

Inherited from: \Zend_Soap_Client::getWsdl()

Returns

Type	Description
string

getWsdlCache() : int

inherited

Get current SOAP Wsdl Caching option

Inherited from: \Zend_Soap_Client::getWsdlCache()

Returns

Type	Description
int

resetSoapInputHeaders() : \Zend_Soap_Client

inherited

Reset SOAP input headers

Inherited from: \Zend_Soap_Client::resetSoapInputHeaders()

Returns

Type	Description
\Zend_Soap_Client

setClassmap(array $classmap) : \Zend_Soap_Client

inherited

Set classmap

Inherited from: \Zend_Soap_Client::setClassmap()

Parameters

Name	Type	Description
$classmap	array

Returns

Type	Description
\Zend_Soap_Client

Throws

Exception	Description
\Zend_Soap_Client_Exception	for any invalid class in the class map

setCompressionOptions(int | null $compressionOptions) : \Zend_Soap_Client

inherited

Set compression options

Inherited from: \Zend_Soap_Client::setCompressionOptions()

Parameters

Name	Type	Description
$compressionOptions	int \| null

Returns

Type	Description
\Zend_Soap_Client

setCookie( $cookieName, $cookieValue = null) : \Zend_Soap_Client

inherited

Inherited from: \Zend_Soap_Client::setCookie()

Parameters

Name	Type	Description
$cookieName
$cookieValue

Returns

Type	Description
\Zend_Soap_Client

setEncoding(string $encoding) : \Zend_Soap_Client

inherited

Set encoding

Inherited from: \Zend_Soap_Client::setEncoding()

Parameters

Name	Type	Description
$encoding	string

Returns

Type	Description
\Zend_Soap_Client

Throws

Exception	Description
\Zend_Soap_Client_Exception	with invalid encoding argument

setEncodingMethod(int $use) : \Zend_Soap_Client

inherited

Set message encoding method

Inherited from: \Zend_Soap_Client::setEncodingMethod()

Parameters

Name	Type	Description
$use	int	One of the SOAP_ENCODED or SOAP_LITERAL constants

Returns

Type	Description
\Zend_Soap_Client

Throws

Exception	Description
\Zend_Soap_Client_Exception	with invalid message encoding method argument

setHttpLogin(string $login) : \Zend_Soap_Client

inherited

Set HTTP login

Inherited from: \Zend_Soap_Client::setHttpLogin()

Parameters

Name	Type	Description
$login	string

Returns

Type	Description
\Zend_Soap_Client

setHttpPassword(string $password) : \Zend_Soap_Client

inherited

Set HTTP password

Inherited from: \Zend_Soap_Client::setHttpPassword()

Parameters

Name	Type	Description
$password	string

Returns

Type	Description
\Zend_Soap_Client

setHttpsCertPassphrase(string $passphrase) : \Zend_Soap_Client

inherited

Set HTTPS client certificate passphrase

Inherited from: \Zend_Soap_Client::setHttpsCertPassphrase()

Parameters

Name	Type	Description
$passphrase	string

Returns

Type	Description
\Zend_Soap_Client

setHttpsCertificate(string $localCert) : \Zend_Soap_Client

inherited

Set HTTPS client certificate path

Inherited from: \Zend_Soap_Client::setHttpsCertificate()

Parameters

Name	Type	Description
$localCert	string	local certificate path

Returns

Type	Description
\Zend_Soap_Client

Throws

Exception	Description
\Zend_Soap_Client_Exception	with invalid local certificate path argument

setLocation(string $location) : \Zend_Soap_Client

inherited

Set Location

Inherited from: \Zend_Soap_Client::setLocation()

URI in Web Service the target namespace

Parameters

Name	Type	Description
$location	string

Returns

Type	Description
\Zend_Soap_Client

Throws

Exception	Description
\Zend_Soap_Client_Exception	with invalid uri argument

setOptions(array | \Zend_Config $options) : \Zend_Soap_Client

inherited

Set Options

Inherited from: \Zend_Soap_Client::setOptions()

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

Parameters

Name	Type	Description
$options	array \| \Zend_Config

Returns

Type	Description
\Zend_Soap_Client

Throws

Exception	Description
\Zend_SoapClient_Exception

setProxyHost(string $proxyHost) : \Zend_Soap_Client

inherited

Set proxy host

Inherited from: \Zend_Soap_Client::setProxyHost()

Parameters

Name	Type	Description
$proxyHost	string

Returns

Type	Description
\Zend_Soap_Client

setProxyLogin(string $proxyLogin) : \Zend_Soap_Client

inherited

Set proxy login

Inherited from: \Zend_Soap_Client::setProxyLogin()

Parameters

Name	Type	Description
$proxyLogin	string

Returns

Type	Description
\Zend_Soap_Client

setProxyPassword( $proxyPassword) : \Zend_Soap_Client

inherited

Set proxy password

Inherited from: \Zend_Soap_Client::setProxyPassword()

Parameters

Name	Type	Description
$proxyPassword

Returns

Type	Description
\Zend_Soap_Client

setProxyPort(int $proxyPort) : \Zend_Soap_Client

inherited

Set proxy port

Inherited from: \Zend_Soap_Client::setProxyPort()

Parameters

Name	Type	Description
$proxyPort	int

Returns

Type	Description
\Zend_Soap_Client

setSoapClient(\SoapClient $soapClient) : \Zend_Soap_Client

inherited

Inherited from: \Zend_Soap_Client::setSoapClient()

Parameters

Name	Type	Description
$soapClient	\SoapClient

Returns

Type	Description
\Zend_Soap_Client

setSoapFeatures(string | int $feature) : \Zend_Soap_Client

inherited

Set the SOAP Feature options.

Inherited from: \Zend_Soap_Client::setSoapFeatures()

Parameters

Name	Type	Description
$feature	string \| int

Returns

Type	Description
\Zend_Soap_Client

setSoapVersion(int $version) : \Zend_Soap_Client

inherited

Set SOAP version

Inherited from: \Zend_Soap_Client::setSoapVersion()

Parameters

Name	Type	Description
$version	int	One of the SOAP_1_1 or SOAP_1_2 constants

Returns

Type	Description
\Zend_Soap_Client

Throws

Exception	Description
\Zend_Soap_Client_Exception	with invalid soap version argument

setStreamContext( $context) : \Zend_Soap_Client

inherited

Set Stream Context

Inherited from: \Zend_Soap_Client::setStreamContext()

Parameters

Name	Type	Description
$context

Returns

Type	Description
\Zend_Soap_Client

setStyle(int $style) : \Zend_Soap_Client

inherited

Set request style

Inherited from: \Zend_Soap_Client::setStyle()

Parameters

Name	Type	Description
$style	int	One of the SOAP_RPC or SOAP_DOCUMENT constants

Returns

Type	Description
\Zend_Soap_Client

Throws

Exception	Description
\Zend_Soap_Client_Exception	with invalid style argument

setUri(string $uri) : \Zend_Soap_Client

inherited

Set URI

Inherited from: \Zend_Soap_Client::setUri()

URI in Web Service the target namespace

Parameters

Name	Type	Description
$uri	string

Returns

Type	Description
\Zend_Soap_Client

Throws

Exception	Description
\Zend_Soap_Client_Exception	with invalid uri argument

setUserAgent(string | null $userAgent) : \Zend_Soap_Client

inherited

Set the string to use in User-Agent header

Inherited from: \Zend_Soap_Client::setUserAgent()

Parameters

Name	Type	Description
$userAgent	string \| null

Returns

Type	Description
\Zend_Soap_Client

setWsdl(string $wsdl) : \Zend_Soap_Client

inherited

Set wsdl

Inherited from: \Zend_Soap_Client::setWsdl()

Parameters

Name	Type	Description
$wsdl	string

Returns

Type	Description
\Zend_Soap_Client

setWsdlCache(string | int | boolean | null $caching) : \Zend_Soap_Client

inherited

Set the SOAP Wsdl Caching Options

Inherited from: \Zend_Soap_Client::setWsdlCache()

Parameters

Name	Type	Description
$caching	string \| int \| boolean \| null

Returns

Type	Description
\Zend_Soap_Client

validateUrn(string $urn) : true

inherited

Check for valid URN

Inherited from: \Zend_Soap_Client::validateUrn()

Parameters

Name	Type	Description
$urn	string

Returns

Type	Description
true

Throws

Exception	Description
\Zend_Soap_Client_Exception	on invalid URN

Soap/Client/Local.php

\Zend_Soap_Client_Localjump to top

Properties

Methods

\Zend_Soap_Client_Local
jump to top