Soap/Client.php

Show:

inherited

Classes
- \Zend_Soap_Client

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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Soap
Subpackage: Client
Version: $Id$

\Zend_Soap_Client
jump to top

Package: Zend_Soap\Client

Zend_Soap_Client

Children: \Zend_Service_DeveloperGarden_Client_Soap; \Zend_Soap_Client_Local; \Zend_Soap_Client_DotNet
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

$_cache_wsdl = null

Default valuenullDetails

Type: n/a

array $_classmap = null

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

Default valuenullDetails

Type: array

$_compression = null

Default valuenullDetails

Type: n/a

$_connection_timeout = null

Default valuenullDetails

Type: n/a

string $_encoding = 'UTF-8'

Encoding

Default value'UTF-8'Details

Type: string

array $_faultExceptions = array()

Registered fault exceptions

Default valuearray()Details

Type: array

$_features = null

Default valuenullDetails

Type: n/a

string $_lastMethod = ''

Last invoked method

Default value''Details

Type: string

$_local_cert = null

Default valuenullDetails

Type: n/a

$_location = null

Default valuenullDetails

Type: n/a

$_login = null

Default valuenullDetails

Type: n/a

$_passphrase = null

Default valuenullDetails

Type: n/a

$_password = null

Default valuenullDetails

Type: n/a

array $_permanentSoapInputHeaders = array()

Permanent SOAP request headers (shared between requests).

Array of SoapHeader objects

Default valuearray()Details

Type: array

$_proxy_host = null

Default valuenullDetails

Type: n/a

$_proxy_login = null

Default valuenullDetails

Type: n/a

$_proxy_password = null

Default valuenullDetails

Type: n/a

$_proxy_port = null

Default valuenullDetails

Type: n/a

\SoapClient $_soapClient

SoapClient object

Details

Type: \SoapClient

array $_soapInputHeaders = array()

SOAP request headers.

Array of SoapHeader objects

Default valuearray()Details

Type: array

array $_soapOutputHeaders = array()

Output SOAP headers.

Array of SoapHeader objects

Default valuearray()Details

Type: array

int $_soapVersion = SOAP_1_2

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

Default valueSOAP_1_2Details

Type: int

$_stream_context = null

Default valuenullDetails

Type: n/a

$_style = null

Default valuenullDetails

Type: n/a

$_uri = null

Set of other SoapClient options

Default valuenullDetails

Type: n/a

$_use = null

Default valuenullDetails

Type: n/a

$_user_agent = null

Default valuenullDetails

Type: n/a

string $_wsdl = null

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

Default valuenullDetails

Type: string

Methods

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

Perform a SOAP call

Parameters

Name	Type	Description
$name	string
$arguments	array

Returns

Type	Description
mixed

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

Constructor

Parameters

Name	Type	Description
$wsdl	string
$options	array

_initSoapClientObject() : void

Initialize SOAP Client object

Throws

Exception	Description
\Zend_Soap_Client_Exception

_preProcessArguments(array $arguments) : void

Perform arguments pre-processing

My be overridden in descendant classes

Parameters

Name	Type	Description
$arguments	array

_preProcessResult( $result) : void

Perform result pre-processing

My be overridden in descendant classes

Parameters

Name	Type	Description
$result

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

Add SOAP input header

Parameters

Name	Type	Description
$header	\SoapHeader
$permanent	boolean

Returns

Type	Description
\Zend_Soap_Client

getClassmap() : mixed

Retrieve classmap

Returns

Type	Description
mixed

getCompressionOptions() : int

Get Compression options

Returns

Type	Description
int

getEncoding() : string

Get encoding

Returns

Type	Description
string

getEncodingMethod() : int

Get message encoding method

Returns

Type	Description
int

getFunctions() : array

Return a list of available functions

Returns

Type	Description
array

Throws

Exception	Description
\Zend_Soap_Client_Exception

getHttpLogin() : string

Retrieve HTTP Login

Returns

Type	Description
string

getHttpPassword() : string

Retrieve HTTP Password

Returns

Type	Description
string

getHttpsCertPassphrase() : string

Get HTTPS client certificate passphrase

Returns

Type	Description
string

getHttpsCertificate() : string

Get HTTPS client certificate path

Returns

Type	Description
string

getLastMethod() : string

Retrieve last invoked method

Returns

Type	Description
string

getLastRequest() : string

Retrieve request XML

Returns

Type	Description
string

getLastRequestHeaders() : string

Retrieve request headers

Returns

Type	Description
string

getLastResponse() : string

Get response XML

Returns

Type	Description
string

getLastResponseHeaders() : string

Retrieve response headers (as string)

Returns

Type	Description
string

getLastSoapOutputHeaderObjects() : array

Get last SOAP output headers

Returns

Type	Description
array

getLocation() : string

Retrieve URI

Returns

Type	Description
string

getOptions() : array

Return array of options suitable for using with SoapClient constructor

Returns

Type	Description
array

getProxyHost() : string

Retrieve proxy host

Returns

Type	Description
string

getProxyLogin() : string

Retrieve proxy login

Returns

Type	Description
string

getProxyPassword() : string

Retrieve proxy password

Returns

Type	Description
string

getProxyPort() : int

Retrieve proxy port

Returns

Type	Description
int

getSoapClient() : \SoapClient

Returns

Type	Description
\SoapClient

getSoapFeatures() : int

Return current SOAP Features options

Returns

Type	Description
int

getSoapVersion() : int

Get SOAP version

Returns

Type	Description
int

getStreamContext() : resource

Get Stream Context

Returns

Type	Description
resource

getStyle() : int

Get request style

Returns

Type	Description
int

getTypes() : array

Return a list of SOAP types

Returns

Type	Description
array

Throws

Exception	Description
\Zend_Soap_Client_Exception

getUri() : string

Retrieve URI

Returns

Type	Description
string

getUserAgent() : string | null

Get current string to use in User-Agent header

Returns

Type	Description
string \| null

getWsdl() : string

Get wsdl

Returns

Type	Description
string

getWsdlCache() : int

Get current SOAP Wsdl Caching option

Returns

Type	Description
int

resetSoapInputHeaders() : \Zend_Soap_Client

Reset SOAP input headers

Returns

Type	Description
\Zend_Soap_Client

setClassmap(array $classmap) : \Zend_Soap_Client

Set classmap

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

Set compression options

Parameters

Name	Type	Description
$compressionOptions	int \| null

Returns

Type	Description
\Zend_Soap_Client

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

Parameters

Name	Type	Description
$cookieName
$cookieValue

Returns

Type	Description
\Zend_Soap_Client

setEncoding(string $encoding) : \Zend_Soap_Client

Set encoding

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

Set message encoding method

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

Set HTTP login

Parameters

Name	Type	Description
$login	string

Returns

Type	Description
\Zend_Soap_Client

setHttpPassword(string $password) : \Zend_Soap_Client

Set HTTP password

Parameters

Name	Type	Description
$password	string

Returns

Type	Description
\Zend_Soap_Client

setHttpsCertPassphrase(string $passphrase) : \Zend_Soap_Client

Set HTTPS client certificate passphrase

Parameters

Name	Type	Description
$passphrase	string

Returns

Type	Description
\Zend_Soap_Client

setHttpsCertificate(string $localCert) : \Zend_Soap_Client

Set HTTPS client certificate path

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

Set Location

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

Set Options

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

Set proxy host

Parameters

Name	Type	Description
$proxyHost	string

Returns

Type	Description
\Zend_Soap_Client

setProxyLogin(string $proxyLogin) : \Zend_Soap_Client

Set proxy login

Parameters

Name	Type	Description
$proxyLogin	string

Returns

Type	Description
\Zend_Soap_Client

setProxyPassword( $proxyPassword) : \Zend_Soap_Client

Set proxy password

Parameters

Name	Type	Description
$proxyPassword

Returns

Type	Description
\Zend_Soap_Client

setProxyPort(int $proxyPort) : \Zend_Soap_Client

Set proxy port

Parameters

Name	Type	Description
$proxyPort	int

Returns

Type	Description
\Zend_Soap_Client

setSoapClient(\SoapClient $soapClient) : \Zend_Soap_Client

Parameters

Name	Type	Description
$soapClient	\SoapClient

Returns

Type	Description
\Zend_Soap_Client

setSoapFeatures(string | int $feature) : \Zend_Soap_Client

Set the SOAP Feature options.

Parameters

Name	Type	Description
$feature	string \| int

Returns

Type	Description
\Zend_Soap_Client

setSoapVersion(int $version) : \Zend_Soap_Client

Set SOAP version

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

Set Stream Context

Parameters

Name	Type	Description
$context

Returns

Type	Description
\Zend_Soap_Client

setStyle(int $style) : \Zend_Soap_Client

Set request style

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

Set URI

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

Set the string to use in User-Agent header

Parameters

Name	Type	Description
$userAgent	string \| null

Returns

Type	Description
\Zend_Soap_Client

setWsdl(string $wsdl) : \Zend_Soap_Client

Set wsdl

Parameters

Name	Type	Description
$wsdl	string

Returns

Type	Description
\Zend_Soap_Client

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

Set the SOAP Wsdl Caching Options

Parameters

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

Returns

Type	Description
\Zend_Soap_Client

validateUrn(string $urn) : true

Check for valid URN

Parameters

Name	Type	Description
$urn	string

Returns

Type	Description
true

Throws

Exception	Description
\Zend_Soap_Client_Exception	on invalid URN

Soap/Client.php

\Zend_Soap_Clientjump to top

Properties

Methods

\Zend_Soap_Client
jump to top