Soap/Client/Local.php

Show: PublicProtectedPrivateinherited
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

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

>VPropertyprotected$_cache_wsdl = null
inheritedInherited from: \Zend_Soap_Client::$$_cache_wsdl
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Soap_Client::$$_cache_wsdl  
>VPropertyprotectedarray $_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  
>VPropertyprotected$_compression = null
inheritedInherited from: \Zend_Soap_Client::$$_compression
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Soap_Client::$$_compression  
>VPropertyprotected$_connection_timeout = null
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Soap_Client::$$_connection_timeout  
>VPropertyprotectedstring $_encoding = 'UTF-8'
inherited
Encoding
Inherited from: \Zend_Soap_Client::$$_encoding
Default value'UTF-8'Details
Type
string
Inherited_from
\Zend_Soap_Client::$$_encoding  
>VPropertyprotectedarray $_faultExceptions = array()
inherited
Registered fault exceptions
Inherited from: \Zend_Soap_Client::$$_faultExceptions
Default valuearray()Details
Type
array
Inherited_from
\Zend_Soap_Client::$$_faultExceptions  
>VPropertyprotected$_features = null
inheritedInherited from: \Zend_Soap_Client::$$_features
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Soap_Client::$$_features  
>VPropertyprotectedstring $_lastMethod = ''
inherited
Last invoked method
Inherited from: \Zend_Soap_Client::$$_lastMethod
Default value''Details
Type
string
Inherited_from
\Zend_Soap_Client::$$_lastMethod  
>VPropertyprotected$_local_cert = null
inheritedInherited from: \Zend_Soap_Client::$$_local_cert
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Soap_Client::$$_local_cert  
>VPropertyprotected$_location = null
inheritedInherited from: \Zend_Soap_Client::$$_location
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Soap_Client::$$_location  
>VPropertyprotected$_login = null
inheritedInherited from: \Zend_Soap_Client::$$_login
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Soap_Client::$$_login  
>VPropertyprotected$_passphrase = null
inheritedInherited from: \Zend_Soap_Client::$$_passphrase
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Soap_Client::$$_passphrase  
>VPropertyprotected$_password = null
inheritedInherited from: \Zend_Soap_Client::$$_password
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Soap_Client::$$_password  
>VPropertyprotectedarray $_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  
>VPropertyprotected$_proxy_host = null
inheritedInherited from: \Zend_Soap_Client::$$_proxy_host
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Soap_Client::$$_proxy_host  
>VPropertyprotected$_proxy_login = null
inheritedInherited from: \Zend_Soap_Client::$$_proxy_login
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Soap_Client::$$_proxy_login  
>VPropertyprotected$_proxy_password = null
inheritedInherited from: \Zend_Soap_Client::$$_proxy_password
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Soap_Client::$$_proxy_password  
>VPropertyprotected$_proxy_port = null
inheritedInherited from: \Zend_Soap_Client::$$_proxy_port
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Soap_Client::$$_proxy_port  
>VPropertyprotected\Zend_Soap_Server $_server
Server object
>VPropertyprotected\SoapClient $_soapClient
inherited
SoapClient object
Inherited from: \Zend_Soap_Client::$$_soapClient
Details
Type
\SoapClient
Inherited_from
\Zend_Soap_Client::$$_soapClient  
>VPropertyprotectedarray $_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  
>VPropertyprotectedarray $_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  
>VPropertyprotectedint $_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  
>VPropertyprotected$_stream_context = null
inheritedInherited from: \Zend_Soap_Client::$$_stream_context
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Soap_Client::$$_stream_context  
>VPropertyprotected$_style = null
inheritedInherited from: \Zend_Soap_Client::$$_style
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Soap_Client::$$_style  
>VPropertyprotected$_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  
>VPropertyprotected$_use = null
inheritedInherited from: \Zend_Soap_Client::$$_use
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Soap_Client::$$_use  
>VPropertyprotected$_user_agent = null
inheritedInherited from: \Zend_Soap_Client::$$_user_agent
Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Soap_Client::$$_user_agent  
>VPropertyprotectedstring $_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

methodpublic__call(string $name, array $arguments) : mixed
inherited

Perform a SOAP call

Inherited from: \Zend_Soap_Client::__call()
Parameters
NameTypeDescription
$namestring
$argumentsarray
Returns
TypeDescription
mixed
methodpublic__construct(\Zend_Soap_Server $server, string $wsdl, array $options = null) : void

Local client constructor

Parameters
NameTypeDescription
$server\Zend_Soap_Server
$wsdlstring
$optionsarray
methodprotected_initSoapClientObject() : void
inherited

Initialize SOAP Client object

Inherited from: \Zend_Soap_Client::_initSoapClientObject()
Throws
ExceptionDescription
\Zend_Soap_Client_Exception
methodprotected_preProcessArguments(array $arguments) : void
inherited

Perform arguments pre-processing

Inherited from: \Zend_Soap_Client::_preProcessArguments()

My be overridden in descendant classes

Parameters
NameTypeDescription
$argumentsarray
methodprotected_preProcessResult( $result) : void
inherited

Perform result pre-processing

Inherited from: \Zend_Soap_Client::_preProcessResult()

My be overridden in descendant classes

Parameters
NameTypeDescription
$result
methodpublicaddSoapInputHeader(\SoapHeader $header, boolean $permanent = false) : \Zend_Soap_Client
inherited

Add SOAP input header

Inherited from: \Zend_Soap_Client::addSoapInputHeader()
Parameters
NameTypeDescription
$header\SoapHeader
$permanentboolean
Returns
TypeDescription
\Zend_Soap_Client
methodpublicgetClassmap() : mixed
inherited

Retrieve classmap

Inherited from: \Zend_Soap_Client::getClassmap()
Returns
TypeDescription
mixed
methodpublicgetCompressionOptions() : int
inherited

Get Compression options

Inherited from: \Zend_Soap_Client::getCompressionOptions()
Returns
TypeDescription
int
methodpublicgetEncoding() : string
inherited

Get encoding

Inherited from: \Zend_Soap_Client::getEncoding()
Returns
TypeDescription
string
methodpublicgetEncodingMethod() : int
inherited

Get message encoding method

Inherited from: \Zend_Soap_Client::getEncodingMethod()
Returns
TypeDescription
int
methodpublicgetFunctions() : array
inherited

Return a list of available functions

Inherited from: \Zend_Soap_Client::getFunctions()
Returns
TypeDescription
array
Throws
ExceptionDescription
\Zend_Soap_Client_Exception
methodpublicgetHttpLogin() : string
inherited

Retrieve HTTP Login

Inherited from: \Zend_Soap_Client::getHttpLogin()
Returns
TypeDescription
string
methodpublicgetHttpPassword() : string
inherited

Retrieve HTTP Password

Inherited from: \Zend_Soap_Client::getHttpPassword()
Returns
TypeDescription
string
methodpublicgetHttpsCertPassphrase() : string
inherited

Get HTTPS client certificate passphrase

Inherited from: \Zend_Soap_Client::getHttpsCertPassphrase()
Returns
TypeDescription
string
methodpublicgetHttpsCertificate() : string
inherited

Get HTTPS client certificate path

Inherited from: \Zend_Soap_Client::getHttpsCertificate()
Returns
TypeDescription
string
methodpublicgetLastMethod() : string
inherited

Retrieve last invoked method

Inherited from: \Zend_Soap_Client::getLastMethod()
Returns
TypeDescription
string
methodpublicgetLastRequest() : string
inherited

Retrieve request XML

Inherited from: \Zend_Soap_Client::getLastRequest()
Returns
TypeDescription
string
methodpublicgetLastRequestHeaders() : string
inherited

Retrieve request headers

Inherited from: \Zend_Soap_Client::getLastRequestHeaders()
Returns
TypeDescription
string
methodpublicgetLastResponse() : string
inherited

Get response XML

Inherited from: \Zend_Soap_Client::getLastResponse()
Returns
TypeDescription
string
methodpublicgetLastResponseHeaders() : string
inherited

Retrieve response headers (as string)

Inherited from: \Zend_Soap_Client::getLastResponseHeaders()
Returns
TypeDescription
string
methodpublicgetLastSoapOutputHeaderObjects() : array
inherited

Get last SOAP output headers

Inherited from: \Zend_Soap_Client::getLastSoapOutputHeaderObjects()
Returns
TypeDescription
array
methodpublicgetLocation() : string
inherited

Retrieve URI

Inherited from: \Zend_Soap_Client::getLocation()
Returns
TypeDescription
string
methodpublicgetOptions() : array
inherited

Return array of options suitable for using with SoapClient constructor

Inherited from: \Zend_Soap_Client::getOptions()
Returns
TypeDescription
array
methodpublicgetProxyHost() : string
inherited

Retrieve proxy host

Inherited from: \Zend_Soap_Client::getProxyHost()
Returns
TypeDescription
string
methodpublicgetProxyLogin() : string
inherited

Retrieve proxy login

Inherited from: \Zend_Soap_Client::getProxyLogin()
Returns
TypeDescription
string
methodpublicgetProxyPassword() : string
inherited

Retrieve proxy password

Inherited from: \Zend_Soap_Client::getProxyPassword()
Returns
TypeDescription
string
methodpublicgetProxyPort() : int
inherited

Retrieve proxy port

Inherited from: \Zend_Soap_Client::getProxyPort()
Returns
TypeDescription
int
methodpublicgetSoapClient() : \SoapClient
inherited

Inherited from: \Zend_Soap_Client::getSoapClient()
Returns
TypeDescription
\SoapClient
methodpublicgetSoapFeatures() : int
inherited

Return current SOAP Features options

Inherited from: \Zend_Soap_Client::getSoapFeatures()
Returns
TypeDescription
int
methodpublicgetSoapVersion() : int
inherited

Get SOAP version

Inherited from: \Zend_Soap_Client::getSoapVersion()
Returns
TypeDescription
int
methodpublicgetStreamContext() : resource
inherited

Get Stream Context

Inherited from: \Zend_Soap_Client::getStreamContext()
Returns
TypeDescription
resource
methodpublicgetStyle() : int
inherited

Get request style

Inherited from: \Zend_Soap_Client::getStyle()
Returns
TypeDescription
int
methodpublicgetTypes() : array
inherited

Return a list of SOAP types

Inherited from: \Zend_Soap_Client::getTypes()
Returns
TypeDescription
array
Throws
ExceptionDescription
\Zend_Soap_Client_Exception
methodpublicgetUri() : string
inherited

Retrieve URI

Inherited from: \Zend_Soap_Client::getUri()
Returns
TypeDescription
string
methodpublicgetUserAgent() : string | null
inherited

Get current string to use in User-Agent header

Inherited from: \Zend_Soap_Client::getUserAgent()
Returns
TypeDescription
string | null
methodpublicgetWsdl() : string
inherited

Get wsdl

Inherited from: \Zend_Soap_Client::getWsdl()
Returns
TypeDescription
string
methodpublicgetWsdlCache() : int
inherited

Get current SOAP Wsdl Caching option

Inherited from: \Zend_Soap_Client::getWsdlCache()
Returns
TypeDescription
int
methodpublicresetSoapInputHeaders() : \Zend_Soap_Client
inherited

Reset SOAP input headers

Inherited from: \Zend_Soap_Client::resetSoapInputHeaders()
Returns
TypeDescription
\Zend_Soap_Client
methodpublicsetClassmap(array $classmap) : \Zend_Soap_Client
inherited

Set classmap

Inherited from: \Zend_Soap_Client::setClassmap()
Parameters
NameTypeDescription
$classmaparray
Returns
TypeDescription
\Zend_Soap_Client
Throws
ExceptionDescription
\Zend_Soap_Client_Exceptionfor any invalid class in the class map
methodpublicsetCompressionOptions(int | null $compressionOptions) : \Zend_Soap_Client
inherited

Set compression options

Inherited from: \Zend_Soap_Client::setCompressionOptions()
Parameters
NameTypeDescription
$compressionOptionsint | null
Returns
TypeDescription
\Zend_Soap_Client
methodpublicsetCookie( $cookieName,  $cookieValue = null) : \Zend_Soap_Client
inherited

Inherited from: \Zend_Soap_Client::setCookie()
Parameters
NameTypeDescription
$cookieName
$cookieValue
Returns
TypeDescription
\Zend_Soap_Client
methodpublicsetEncoding(string $encoding) : \Zend_Soap_Client
inherited

Set encoding

Inherited from: \Zend_Soap_Client::setEncoding()
Parameters
NameTypeDescription
$encodingstring
Returns
TypeDescription
\Zend_Soap_Client
Throws
ExceptionDescription
\Zend_Soap_Client_Exceptionwith invalid encoding argument
methodpublicsetEncodingMethod(int $use) : \Zend_Soap_Client
inherited

Set message encoding method

Inherited from: \Zend_Soap_Client::setEncodingMethod()
Parameters
NameTypeDescription
$useint

One of the SOAP_ENCODED or SOAP_LITERAL constants

Returns
TypeDescription
\Zend_Soap_Client
Throws
ExceptionDescription
\Zend_Soap_Client_Exceptionwith invalid message encoding method argument
methodpublicsetHttpLogin(string $login) : \Zend_Soap_Client
inherited

Set HTTP login

Inherited from: \Zend_Soap_Client::setHttpLogin()
Parameters
NameTypeDescription
$loginstring
Returns
TypeDescription
\Zend_Soap_Client
methodpublicsetHttpPassword(string $password) : \Zend_Soap_Client
inherited

Set HTTP password

Inherited from: \Zend_Soap_Client::setHttpPassword()
Parameters
NameTypeDescription
$passwordstring
Returns
TypeDescription
\Zend_Soap_Client
methodpublicsetHttpsCertPassphrase(string $passphrase) : \Zend_Soap_Client
inherited

Set HTTPS client certificate passphrase

Inherited from: \Zend_Soap_Client::setHttpsCertPassphrase()
Parameters
NameTypeDescription
$passphrasestring
Returns
TypeDescription
\Zend_Soap_Client
methodpublicsetHttpsCertificate(string $localCert) : \Zend_Soap_Client
inherited

Set HTTPS client certificate path

Inherited from: \Zend_Soap_Client::setHttpsCertificate()
Parameters
NameTypeDescription
$localCertstring

local certificate path

Returns
TypeDescription
\Zend_Soap_Client
Throws
ExceptionDescription
\Zend_Soap_Client_Exceptionwith invalid local certificate path argument
methodpublicsetLocation(string $location) : \Zend_Soap_Client
inherited

Set Location

Inherited from: \Zend_Soap_Client::setLocation()

URI in Web Service the target namespace

Parameters
NameTypeDescription
$locationstring
Returns
TypeDescription
\Zend_Soap_Client
Throws
ExceptionDescription
\Zend_Soap_Client_Exceptionwith invalid uri argument
methodpublicsetOptions(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
NameTypeDescription
$optionsarray | \Zend_Config
Returns
TypeDescription
\Zend_Soap_Client
Throws
ExceptionDescription
\Zend_SoapClient_Exception
methodpublicsetProxyHost(string $proxyHost) : \Zend_Soap_Client
inherited

Set proxy host

Inherited from: \Zend_Soap_Client::setProxyHost()
Parameters
NameTypeDescription
$proxyHoststring
Returns
TypeDescription
\Zend_Soap_Client
methodpublicsetProxyLogin(string $proxyLogin) : \Zend_Soap_Client
inherited

Set proxy login

Inherited from: \Zend_Soap_Client::setProxyLogin()
Parameters
NameTypeDescription
$proxyLoginstring
Returns
TypeDescription
\Zend_Soap_Client
methodpublicsetProxyPassword( $proxyPassword) : \Zend_Soap_Client
inherited

Set proxy password

Inherited from: \Zend_Soap_Client::setProxyPassword()
Parameters
NameTypeDescription
$proxyPassword
Returns
TypeDescription
\Zend_Soap_Client
methodpublicsetProxyPort(int $proxyPort) : \Zend_Soap_Client
inherited

Set proxy port

Inherited from: \Zend_Soap_Client::setProxyPort()
Parameters
NameTypeDescription
$proxyPortint
Returns
TypeDescription
\Zend_Soap_Client
methodpublicsetSoapClient(\SoapClient $soapClient) : \Zend_Soap_Client
inherited

Inherited from: \Zend_Soap_Client::setSoapClient()
Parameters
NameTypeDescription
$soapClient\SoapClient
Returns
TypeDescription
\Zend_Soap_Client
methodpublicsetSoapFeatures(string | int $feature) : \Zend_Soap_Client
inherited

Set the SOAP Feature options.

Inherited from: \Zend_Soap_Client::setSoapFeatures()
Parameters
NameTypeDescription
$featurestring | int
Returns
TypeDescription
\Zend_Soap_Client
methodpublicsetSoapVersion(int $version) : \Zend_Soap_Client
inherited

Set SOAP version

Inherited from: \Zend_Soap_Client::setSoapVersion()
Parameters
NameTypeDescription
$versionint

One of the SOAP_1_1 or SOAP_1_2 constants

Returns
TypeDescription
\Zend_Soap_Client
Throws
ExceptionDescription
\Zend_Soap_Client_Exceptionwith invalid soap version argument
methodpublicsetStreamContext( $context) : \Zend_Soap_Client
inherited

Set Stream Context

Inherited from: \Zend_Soap_Client::setStreamContext()
Parameters
NameTypeDescription
$context
Returns
TypeDescription
\Zend_Soap_Client
methodpublicsetStyle(int $style) : \Zend_Soap_Client
inherited

Set request style

Inherited from: \Zend_Soap_Client::setStyle()
Parameters
NameTypeDescription
$styleint

One of the SOAP_RPC or SOAP_DOCUMENT constants

Returns
TypeDescription
\Zend_Soap_Client
Throws
ExceptionDescription
\Zend_Soap_Client_Exceptionwith invalid style argument
methodpublicsetUri(string $uri) : \Zend_Soap_Client
inherited

Set URI

Inherited from: \Zend_Soap_Client::setUri()

URI in Web Service the target namespace

Parameters
NameTypeDescription
$uristring
Returns
TypeDescription
\Zend_Soap_Client
Throws
ExceptionDescription
\Zend_Soap_Client_Exceptionwith invalid uri argument
methodpublicsetUserAgent(string | null $userAgent) : \Zend_Soap_Client
inherited

Set the string to use in User-Agent header

Inherited from: \Zend_Soap_Client::setUserAgent()
Parameters
NameTypeDescription
$userAgentstring | null
Returns
TypeDescription
\Zend_Soap_Client
methodpublicsetWsdl(string $wsdl) : \Zend_Soap_Client
inherited

Set wsdl

Inherited from: \Zend_Soap_Client::setWsdl()
Parameters
NameTypeDescription
$wsdlstring
Returns
TypeDescription
\Zend_Soap_Client
methodpublicsetWsdlCache(string | int | boolean | null $caching) : \Zend_Soap_Client
inherited

Set the SOAP Wsdl Caching Options

Inherited from: \Zend_Soap_Client::setWsdlCache()
Parameters
NameTypeDescription
$cachingstring | int | boolean | null
Returns
TypeDescription
\Zend_Soap_Client
methodpublicvalidateUrn(string $urn) : true
inherited

Check for valid URN

Inherited from: \Zend_Soap_Client::validateUrn()
Parameters
NameTypeDescription
$urnstring
Returns
TypeDescription
true
Throws
ExceptionDescription
\Zend_Soap_Client_Exceptionon invalid URN
Documentation was generated by phpDocumentor 2.0.0a12.