API Documentation

Soap/Client.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Soap
subpackage
Client
version
$Id: Client.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Soap_Client

Description

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.

Zend_Soap_Client
jump to top

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Soap
subpackage
Client
Properties
$_encoding
$_classmap
$_faultExceptions
$_soapVersion
$_uri
$_location
$_style
$_use
$_login
$_password
$_proxy_host
$_proxy_port
$_proxy_login
$_proxy_password
$_local_cert
$_passphrase
$_compression
$_connection_timeout
$_stream_context
$_features
$_cache_wsdl
$_user_agent
$_wsdl
$_soapClient
$_lastMethod
$_soapInputHeaders
$_permanentSoapInputHeaders
$_soapOutputHeaders
Methods
__construct
setWsdl
getWsdl
setOptions
getOptions
setSoapVersion
getSoapVersion
setClassmap
getClassmap
setEncoding
getEncoding
validateUrn
setUri
getUri
setLocation
getLocation
setStyle
getStyle
setEncodingMethod
getEncodingMethod
setHttpLogin
getHttpLogin
setHttpPassword
getHttpPassword
setProxyHost
getProxyHost
setProxyPort
getProxyPort
setProxyLogin
getProxyLogin
setProxyPassword
setHttpsCertificate
getHttpsCertificate
setHttpsCertPassphrase
getHttpsCertPassphrase
setCompressionOptions
getCompressionOptions
getProxyPassword
setStreamContext
getStreamContext
setSoapFeatures
getSoapFeatures
setWsdlCache
getWsdlCache
setUserAgent
getUserAgent
getLastRequest
getLastResponse
getLastRequestHeaders
getLastResponseHeaders
getLastMethod
_doRequest
_initSoapClientObject
_preProcessArguments
_preProcessResult
addSoapInputHeader
resetSoapInputHeaders
getLastSoapOutputHeaderObjects
__call
getFunctions
getTypes
setSoapClient
getSoapClient
setCookie

Description

Zend_Soap_Client

Properties

$_cache_wsdl
jump to class

 $_cache_wsdl = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_classmap
jump to class

array $_classmap = 'null'

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

Details

$_classmap
array
visibility
protected
default
null
final
false
static
false

$_compression
jump to class

 $_compression = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_connection_timeout
jump to class

 $_connection_timeout = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_encoding
jump to class

string $_encoding = 'UTF-8'

Encoding

Details

$_encoding
string
visibility
protected
default
UTF-8
final
false
static
false

$_faultExceptions
jump to class

array $_faultExceptions = 'array'

Registered fault exceptions

Details

$_faultExceptions
array
visibility
protected
default
array
final
false
static
false

$_features
jump to class

 $_features = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_lastMethod
jump to class

string $_lastMethod = ''

Last invoked method

Details

$_lastMethod
string
visibility
protected
default
final
false
static
false

$_local_cert
jump to class

 $_local_cert = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_location
jump to class

 $_location = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_login
jump to class

 $_login = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_passphrase
jump to class

 $_passphrase = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_password
jump to class

 $_password = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_permanentSoapInputHeaders
jump to class

array $_permanentSoapInputHeaders = 'array'

Permanent SOAP request headers (shared between requests).

Array of SoapHeader objects

Details

$_permanentSoapInputHeaders
array
visibility
protected
default
array
final
false
static
false

$_proxy_host
jump to class

 $_proxy_host = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_proxy_login
jump to class

 $_proxy_login = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_proxy_password
jump to class

 $_proxy_password = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_proxy_port
jump to class

 $_proxy_port = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_soapClient
jump to class

SoapClient $_soapClient = ''

SoapClient object

Details

$_soapClient
SoapClient
visibility
protected
default
final
false
static
false

$_soapInputHeaders
jump to class

array $_soapInputHeaders = 'array'

SOAP request headers.

Array of SoapHeader objects

Details

$_soapInputHeaders
array
visibility
protected
default
array
final
false
static
false

$_soapOutputHeaders
jump to class

array $_soapOutputHeaders = 'array'

Output SOAP headers.

Array of SoapHeader objects

Details

$_soapOutputHeaders
array
visibility
protected
default
array
final
false
static
false

$_soapVersion
jump to class

int $_soapVersion = 'SOAP_1_2'

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

Details

$_soapVersion
int
visibility
protected
default
SOAP_1_2
final
false
static
false

$_stream_context
jump to class

 $_stream_context = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_style
jump to class

 $_style = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_uri
jump to class

 $_uri = 'null'

Set of other SoapClient options

Details

visibility
protected
default
null
final
false
static
false

$_use
jump to class

 $_use = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_user_agent
jump to class

 $_user_agent = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_wsdl
jump to class

string $_wsdl = 'null'

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

Details

$_wsdl
string
visibility
protected
default
null
final
false
static
false

Methods

__call
jump to class

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

Perform a SOAP call

Arguments
$name
string
$arguments
array
Output
mixed
Details
visibility
public
final
false
static
false

__construct
jump to class

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

Constructor

Arguments
$wsdl
string
$options
array
Details
visibility
public
final
false
static
false

_doRequest
jump to class

_doRequest( Zend_Soap_Client_Common $client, string $request, string $location, string $action, int $version, int $one_way = null ) : mixed

Do request proxy method.

May be overridden in subclasses

Arguments
$client
Zend_Soap_Client_Common
$request
string
$location
string
$action
string
$version
int
$one_way
int
Output
mixed
Details
visibility
public
final
false
static
false
internal

_initSoapClientObject
jump to class

_initSoapClientObject( ) :

Initialize SOAP Client object

Details
visibility
protected
final
false
static
false
throws

_preProcessArguments
jump to class

_preProcessArguments( array $arguments ) :

Perform arguments pre-processing

My be overridden in descendant classes

Arguments
$arguments
array
Details
visibility
protected
final
false
static
false

_preProcessResult
jump to class

_preProcessResult(  $result ) :

Perform result pre-processing

My be overridden in descendant classes

Arguments
$result
Details
visibility
protected
final
false
static
false

addSoapInputHeader
jump to class

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

Add SOAP input header

Arguments
$header
SoapHeader
$permanent
boolean
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false

getClassmap
jump to class

getClassmap( ) : mixed

Retrieve classmap

Output
mixed
Details
visibility
public
final
false
static
false

getCompressionOptions
jump to class

getCompressionOptions( ) : int

Get Compression options

Output
int
Details
visibility
public
final
false
static
false

getEncoding
jump to class

getEncoding( ) : string

Get encoding

Output
string
Details
visibility
public
final
false
static
false

getEncodingMethod
jump to class

getEncodingMethod( ) : int

Get message encoding method

Output
int
Details
visibility
public
final
false
static
false

getFunctions
jump to class

getFunctions( ) : array

Return a list of available functions

Output
array
Details
visibility
public
final
false
static
false
throws

getHttpLogin
jump to class

getHttpLogin( ) : string

Retrieve HTTP Login

Output
string
Details
visibility
public
final
false
static
false

getHttpPassword
jump to class

getHttpPassword( ) : string

Retrieve HTTP Password

Output
string
Details
visibility
public
final
false
static
false

getHttpsCertPassphrase
jump to class

getHttpsCertPassphrase( ) : string

Get HTTPS client certificate passphrase

Output
string
Details
visibility
public
final
false
static
false

getHttpsCertificate
jump to class

getHttpsCertificate( ) : string

Get HTTPS client certificate path

Output
string
Details
visibility
public
final
false
static
false

getLastMethod
jump to class

getLastMethod( ) : string

Retrieve last invoked method

Output
string
Details
visibility
public
final
false
static
false

getLastRequest
jump to class

getLastRequest( ) : string

Retrieve request XML

Output
string
Details
visibility
public
final
false
static
false

getLastRequestHeaders
jump to class

getLastRequestHeaders( ) : string

Retrieve request headers

Output
string
Details
visibility
public
final
false
static
false

getLastResponse
jump to class

getLastResponse( ) : string

Get response XML

Output
string
Details
visibility
public
final
false
static
false

getLastResponseHeaders
jump to class

getLastResponseHeaders( ) : string

Retrieve response headers (as string)

Output
string
Details
visibility
public
final
false
static
false

getLastSoapOutputHeaderObjects
jump to class

getLastSoapOutputHeaderObjects( ) : array

Get last SOAP output headers

Output
array
Details
visibility
public
final
false
static
false

getLocation
jump to class

getLocation( ) : string

Retrieve URI

Output
string
Details
visibility
public
final
false
static
false

getOptions
jump to class

getOptions( ) : array

Return array of options suitable for using with SoapClient constructor

Output
array
Details
visibility
public
final
false
static
false

getProxyHost
jump to class

getProxyHost( ) : string

Retrieve proxy host

Output
string
Details
visibility
public
final
false
static
false

getProxyLogin
jump to class

getProxyLogin( ) : string

Retrieve proxy login

Output
string
Details
visibility
public
final
false
static
false

getProxyPassword
jump to class

getProxyPassword( ) : string

Retrieve proxy password

Output
string
Details
visibility
public
final
false
static
false

getProxyPort
jump to class

getProxyPort( ) : int

Retrieve proxy port

Output
int
Details
visibility
public
final
false
static
false

getSoapClient
jump to class

getSoapClient( ) : SoapClient

Output
SoapClient
Details
visibility
public
final
false
static
false

getSoapFeatures
jump to class

getSoapFeatures( ) : int

Return current SOAP Features options

Output
int
Details
visibility
public
final
false
static
false

getSoapVersion
jump to class

getSoapVersion( ) : int

Get SOAP version

Output
int
Details
visibility
public
final
false
static
false

getStreamContext
jump to class

getStreamContext( ) : resource

Get Stream Context

Output
resource
Details
visibility
public
final
false
static
false

getStyle
jump to class

getStyle( ) : int

Get request style

Output
int
Details
visibility
public
final
false
static
false

getTypes
jump to class

getTypes( ) : array

Return a list of SOAP types

Output
array
Details
visibility
public
final
false
static
false
throws

getUri
jump to class

getUri( ) : string

Retrieve URI

Output
string
Details
visibility
public
final
false
static
false

getUserAgent
jump to class

getUserAgent( ) : string|null

Get current string to use in User-Agent header

Output
string|null
Details
visibility
public
final
false
static
false

getWsdl
jump to class

getWsdl( ) : string

Get wsdl

Output
string
Details
visibility
public
final
false
static
false

getWsdlCache
jump to class

getWsdlCache( ) :

Get current SOAP Wsdl Caching option

Details
visibility
public
final
false
static
false

resetSoapInputHeaders
jump to class

resetSoapInputHeaders( ) : Zend_Soap_Client

Reset SOAP input headers

Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false

setClassmap
jump to class

setClassmap( array $classmap ) : Zend_Soap_Client

Set classmap

Arguments
$classmap
array
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false
throws
for any invalid class in the class map

setCompressionOptions
jump to class

setCompressionOptions( int $compressionOptions ) : Zend_Soap_Client

Set compression options

Arguments
$compressionOptions
int
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false

setCookie
jump to class

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

Arguments
$cookieName
$cookieValue
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false

setEncoding
jump to class

setEncoding( string $encoding ) : Zend_Soap_Client

Set encoding

Arguments
$encoding
string
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false
throws
with invalid encoding argument

setEncodingMethod
jump to class

setEncodingMethod( int $use ) : Zend_Soap_Client

Set message encoding method

Arguments
$use
int
One of the SOAP_ENCODED or SOAP_LITERAL constants
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false
throws
with invalid message encoding method argument

setHttpLogin
jump to class

setHttpLogin( string $login ) : Zend_Soap_Client

Set HTTP login

Arguments
$login
string
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false

setHttpPassword
jump to class

setHttpPassword( string $password ) : Zend_Soap_Client

Set HTTP password

Arguments
$password
string
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false

setHttpsCertPassphrase
jump to class

setHttpsCertPassphrase( string $passphrase ) : Zend_Soap_Client

Set HTTPS client certificate passphrase

Arguments
$passphrase
string
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false

setHttpsCertificate
jump to class

setHttpsCertificate( string $localCert ) : Zend_Soap_Client

Set HTTPS client certificate path

Arguments
$localCert
string
local certificate path
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false
throws
with invalid local certificate path argument

setLocation
jump to class

setLocation( string $location ) : Zend_Soap_Client

Set Location

URI in Web Service the target namespace

Arguments
$location
string
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false
throws
with invalid uri argument

setOptions
jump to class

setOptions( array|Zend_Config $options ) : Zend_Soap_Client

Set Options

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

Arguments
$options
arrayZend_Config
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false
throws

setProxyHost
jump to class

setProxyHost( string $proxyHost ) : Zend_Soap_Client

Set proxy host

Arguments
$proxyHost
string
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false

setProxyLogin
jump to class

setProxyLogin( string $proxyLogin ) : Zend_Soap_Client

Set proxy login

Arguments
$proxyLogin
string
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false

setProxyPassword
jump to class

setProxyPassword(  $proxyPassword ) : Zend_Soap_Client

Set proxy password

Arguments
$proxyPassword
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false

setProxyPort
jump to class

setProxyPort( int $proxyPort ) : Zend_Soap_Client

Set proxy port

Arguments
$proxyPort
int
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false

setSoapClient
jump to class

setSoapClient( SoapClient $soapClient ) : Zend_Soap_Client

Arguments
$soapClient
SoapClient
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false

setSoapFeatures
jump to class

setSoapFeatures( string|int $feature ) : Zend_Soap_Client

Set the SOAP Feature options.

Arguments
$feature
stringint
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false

setSoapVersion
jump to class

setSoapVersion( int $version ) : Zend_Soap_Client

Set SOAP version

Arguments
$version
int
One of the SOAP_1_1 or SOAP_1_2 constants
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false
throws
with invalid soap version argument

setStreamContext
jump to class

setStreamContext(  $context ) : Zend_Soap_Client

Set Stream Context

Arguments
$context
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false

setStyle
jump to class

setStyle( int $style ) : Zend_Soap_Client

Set request style

Arguments
$style
int
One of the SOAP_RPC or SOAP_DOCUMENT constants
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false
throws
with invalid style argument

setUri
jump to class

setUri( string $uri ) : Zend_Soap_Client

Set URI

URI in Web Service the target namespace

Arguments
$uri
string
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false
throws
with invalid uri argument

setUserAgent
jump to class

setUserAgent( string|null $userAgent ) : Zend_Soap_Client

Set the string to use in User-Agent header

Arguments
$userAgent
stringnull
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false

setWsdl
jump to class

setWsdl( string $wsdl ) : Zend_Soap_Client

Set wsdl

Arguments
$wsdl
string
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false

setWsdlCache
jump to class

setWsdlCache(  $options ) : Zend_Soap_Client

Set the SOAP Wsdl Caching Options

Arguments
$options
Output
Zend_Soap_Client
Details
visibility
public
final
false
static
false

validateUrn
jump to class

validateUrn( string $urn ) : true

Check for valid URN

Arguments
$urn
string
Output
true
Details
visibility
public
final
false
static
false
throws
on invalid URN
Documentation was generated by DocBlox.