Moodle  2.2.1
http://www.collinsharper.com
Zend_Soap_Client Class Reference
Inheritance diagram for Zend_Soap_Client:

Public Member Functions

 __construct ($wsdl=null, $options=null)
 setWsdl ($wsdl)
 getWsdl ()
 setOptions ($options)
 getOptions ()
 setSoapVersion ($version)
 getSoapVersion ()
 setClassmap (array $classmap)
 getClassmap ()
 setEncoding ($encoding)
 getEncoding ()
 validateUrn ($urn)
 setUri ($uri)
 getUri ()
 setLocation ($location)
 getLocation ()
 setStyle ($style)
 getStyle ()
 setEncodingMethod ($use)
 getEncodingMethod ()
 setHttpLogin ($login)
 getHttpLogin ()
 setHttpPassword ($password)
 getHttpPassword ()
 setProxyHost ($proxyHost)
 getProxyHost ()
 setProxyPort ($proxyPort)
 getProxyPort ()
 setProxyLogin ($proxyLogin)
 getProxyLogin ()
 setProxyPassword ($proxyPassword)
 setHttpsCertificate ($localCert)
 getHttpsCertificate ()
 setHttpsCertPassphrase ($passphrase)
 getHttpsCertPassphrase ()
 setCompressionOptions ($compressionOptions)
 getCompressionOptions ()
 getProxyPassword ()
 setStreamContext ($context)
 getStreamContext ()
 setSoapFeatures ($feature)
 getSoapFeatures ()
 setWsdlCache ($options)
 getWsdlCache ()
 setUserAgent ($userAgent)
 getUserAgent ()
 getLastRequest ()
 getLastResponse ()
 getLastRequestHeaders ()
 getLastResponseHeaders ()
 getLastMethod ()
 _doRequest (Zend_Soap_Client_Common $client, $request, $location, $action, $version, $one_way=null)
 addSoapInputHeader (SoapHeader $header, $permanent=false)
 resetSoapInputHeaders ()
 getLastSoapOutputHeaderObjects ()
 __call ($name, $arguments)
 getFunctions ()
 getTypes ()
 setSoapClient (SoapClient $soapClient)
 getSoapClient ()
 setCookie ($cookieName, $cookieValue=null)

Protected Member Functions

 _initSoapClientObject ()
 _preProcessArguments ($arguments)
 _preProcessResult ($result)

Protected Attributes

 $_encoding = 'UTF-8'
 $_classmap = null
 $_faultExceptions = array()
 $_soapVersion = SOAP_1_2
 $_uri = null
 $_location = null
 $_style = null
 $_use = null
 $_login = null
 $_password = null
 $_proxy_host = null
 $_proxy_port = null
 $_proxy_login = null
 $_proxy_password = null
 $_local_cert = null
 $_passphrase = null
 $_compression = null
 $_connection_timeout = null
 $_stream_context = null
 $_features = null
 $_cache_wsdl = null
 $_user_agent = null
 $_wsdl = null
 $_soapClient
 $_lastMethod = ''
 $_soapInputHeaders = array()
 $_permanentSoapInputHeaders = array()
 $_soapOutputHeaders = array()

Detailed Description

Definition at line 47 of file Client.php.


Constructor & Destructor Documentation

__construct ( wsdl = null,
options = null 
)

Constructor

Parameters:
string$wsdl
array$options

Definition at line 148 of file Client.php.

Here is the call graph for this function:


Member Function Documentation

__call ( name,
arguments 
)

Perform a SOAP call

Parameters:
string$name
array$arguments
Returns:
mixed

Reimplemented in Zend_Service_DeveloperGarden_Client_Soap.

Definition at line 1102 of file Client.php.

Here is the call graph for this function:

Here is the caller graph for this function:

_doRequest ( Zend_Soap_Client_Common $  client,
request,
location,
action,
version,
one_way = null 
)

Do request proxy method.

May be overridden in subclasses

Definition at line 983 of file Client.php.

_initSoapClientObject ( ) [protected]

Initialize SOAP Client object

Exceptions:
Zend_Soap_Client_Exception

Definition at line 998 of file Client.php.

Here is the call graph for this function:

Here is the caller graph for this function:

_preProcessArguments ( arguments) [protected]

Perform arguments pre-processing

My be overridden in descendant classes

Parameters:
array$arguments

Definition at line 1035 of file Client.php.

Here is the caller graph for this function:

_preProcessResult ( result) [protected]

Perform result pre-processing

My be overridden in descendant classes

Parameters:
array$arguments

Definition at line 1048 of file Client.php.

Here is the caller graph for this function:

addSoapInputHeader ( SoapHeader $  header,
permanent = false 
)

Add SOAP input header

Parameters:
SoapHeader$header
boolean$permanent
Returns:
Zend_Soap_Client

Definition at line 1061 of file Client.php.

Here is the caller graph for this function:

Retrieve classmap

Returns:
mixed

Definition at line 396 of file Client.php.

Here is the caller graph for this function:

Get Compression options

Returns:
int

Definition at line 787 of file Client.php.

Here is the caller graph for this function:

Get encoding

Returns:
string

Definition at line 427 of file Client.php.

Here is the caller graph for this function:

Get message encoding method

Returns:
int

Definition at line 566 of file Client.php.

Here is the caller graph for this function:

Return a list of available functions

Returns:
array
Exceptions:
Zend_Soap_Client_Exception

Definition at line 1128 of file Client.php.

Here is the call graph for this function:

Retrieve HTTP Login

Returns:
string

Definition at line 591 of file Client.php.

Here is the caller graph for this function:

Retrieve HTTP Password

Returns:
string

Definition at line 616 of file Client.php.

Here is the caller graph for this function:

Get HTTPS client certificate path

Returns:
string

Definition at line 737 of file Client.php.

Here is the caller graph for this function:

Get HTTPS client certificate passphrase

Returns:
string

Definition at line 762 of file Client.php.

Here is the caller graph for this function:

Retrieve last invoked method

Returns:
string

Definition at line 964 of file Client.php.

Retrieve request XML

Returns:
string

Definition at line 908 of file Client.php.

Retrieve request headers

Returns:
string

Definition at line 936 of file Client.php.

Get response XML

Returns:
string

Definition at line 922 of file Client.php.

Retrieve response headers (as string)

Returns:
string

Definition at line 950 of file Client.php.

Get last SOAP output headers

Returns:
array

Definition at line 1090 of file Client.php.

Retrieve URI

Returns:
string

Definition at line 504 of file Client.php.

Here is the caller graph for this function:

Return array of options suitable for using with SoapClient constructor

Returns:
array

Definition at line 292 of file Client.php.

Here is the call graph for this function:

Here is the caller graph for this function:

Retrieve proxy host

Returns:
string

Definition at line 641 of file Client.php.

Here is the caller graph for this function:

Retrieve proxy login

Returns:
string

Definition at line 691 of file Client.php.

Here is the caller graph for this function:

Retrieve proxy password

Returns:
string

Definition at line 797 of file Client.php.

Here is the caller graph for this function:

Retrieve proxy port

Returns:
int

Definition at line 666 of file Client.php.

Here is the caller graph for this function:

Returns:
SoapClient

Definition at line 1177 of file Client.php.

Here is the call graph for this function:

Here is the caller graph for this function:

Return current SOAP Features options

Returns:
int

Definition at line 852 of file Client.php.

Here is the caller graph for this function:

Get SOAP version

Returns:
int

Definition at line 363 of file Client.php.

Here is the caller graph for this function:

Get Stream Context

Returns:
resource

Definition at line 828 of file Client.php.

Here is the caller graph for this function:

getStyle ( )

Get request style

Returns:
int

Definition at line 535 of file Client.php.

Here is the caller graph for this function:

getTypes ( )

Get used types.

Returns:
array Return a list of SOAP types
array
Exceptions:
Zend_Soap_Client_Exception

Definition at line 1152 of file Client.php.

Here is the call graph for this function:

getUri ( )

Retrieve URI

Returns:
string

Definition at line 475 of file Client.php.

Here is the caller graph for this function:

Get current string to use in User-Agent header

Returns:
string|null

Definition at line 898 of file Client.php.

Here is the caller graph for this function:

getWsdl ( )

Get wsdl

Returns:
string

Definition at line 182 of file Client.php.

Here is the caller graph for this function:

Get current SOAP Wsdl Caching option

Definition at line 872 of file Client.php.

Here is the caller graph for this function:

Reset SOAP input headers

Returns:
Zend_Soap_Client

Definition at line 1077 of file Client.php.

setClassmap ( array classmap)

Set classmap

Parameters:
array$classmap
Returns:
Zend_Soap_Client
Exceptions:
Zend_Soap_Client_Exceptionfor any invalid class in the class map

Definition at line 375 of file Client.php.

Here is the caller graph for this function:

setCompressionOptions ( compressionOptions)

Set compression options

Parameters:
int$compressionOptions
Returns:
Zend_Soap_Client

Definition at line 773 of file Client.php.

Here is the caller graph for this function:

setCookie ( cookieName,
cookieValue = null 
)
Parameters:
string$name
string$value
Returns:
Zend_Soap_Client

Definition at line 1190 of file Client.php.

Here is the call graph for this function:

setEncoding ( encoding)

Set encoding

Parameters:
string$encoding
Returns:
Zend_Soap_Client
Exceptions:
Zend_Soap_Client_Exceptionwith invalid encoding argument

Definition at line 408 of file Client.php.

Here is the caller graph for this function:

setEncodingMethod ( use)

Set message encoding method

Parameters:
int$useOne of the SOAP_ENCODED or SOAP_LITERAL constants
Returns:
Zend_Soap_Client
Exceptions:
Zend_Soap_Client_Exceptionwith invalid message encoding method argument

Definition at line 547 of file Client.php.

Here is the caller graph for this function:

setHttpLogin ( login)

Set HTTP login

Parameters:
string$login
Returns:
Zend_Soap_Client

Definition at line 577 of file Client.php.

Here is the caller graph for this function:

setHttpPassword ( password)

Set HTTP password

Parameters:
string$password
Returns:
Zend_Soap_Client

Definition at line 602 of file Client.php.

Here is the caller graph for this function:

setHttpsCertificate ( localCert)

Set HTTPS client certificate path

Parameters:
string$localCertlocal certificate path
Returns:
Zend_Soap_Client
Exceptions:
Zend_Soap_Client_Exceptionwith invalid local certificate path argument

Definition at line 718 of file Client.php.

Here is the caller graph for this function:

setHttpsCertPassphrase ( passphrase)

Set HTTPS client certificate passphrase

Parameters:
string$passphrase
Returns:
Zend_Soap_Client

Definition at line 748 of file Client.php.

Here is the caller graph for this function:

setLocation ( location)

Set Location

URI in Web Service the target namespace

Parameters:
string$location
Returns:
Zend_Soap_Client
Exceptions:
Zend_Soap_Client_Exceptionwith invalid uri argument

Definition at line 489 of file Client.php.

Here is the call graph for this function:

Here is the caller graph for this function:

setOptions ( options)

Set Options

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

Parameters:
array | Zend_Config$options
Returns:
Zend_Soap_Client
Exceptions:
Zend_SoapClient_Exception

Definition at line 196 of file Client.php.

Here is the call graph for this function:

Here is the caller graph for this function:

setProxyHost ( proxyHost)

Set proxy host

Parameters:
string$proxyHost
Returns:
Zend_Soap_Client

Definition at line 627 of file Client.php.

Here is the caller graph for this function:

setProxyLogin ( proxyLogin)

Set proxy login

Parameters:
string$proxyLogin
Returns:
Zend_Soap_Client

Definition at line 677 of file Client.php.

Here is the caller graph for this function:

setProxyPassword ( proxyPassword)

Set proxy password

Parameters:
string$proxyLogin
Returns:
Zend_Soap_Client

Definition at line 702 of file Client.php.

Here is the caller graph for this function:

setProxyPort ( proxyPort)

Set proxy port

Parameters:
int$proxyPort
Returns:
Zend_Soap_Client

Definition at line 652 of file Client.php.

Here is the caller graph for this function:

setSoapClient ( SoapClient $  soapClient)
Parameters:
SoapClient$soapClient
Returns:
Zend_Soap_Client

Definition at line 1168 of file Client.php.

setSoapFeatures ( feature)

Set the SOAP Feature options.

Parameters:
string | int$feature
Returns:
Zend_Soap_Client

Definition at line 839 of file Client.php.

Here is the caller graph for this function:

setSoapVersion ( version)

Set SOAP version

Parameters:
int$versionOne of the SOAP_1_1 or SOAP_1_2 constants
Returns:
Zend_Soap_Client
Exceptions:
Zend_Soap_Client_Exceptionwith invalid soap version argument

Definition at line 345 of file Client.php.

Here is the caller graph for this function:

setStreamContext ( context)

Set Stream Context

Returns:
Zend_Soap_Client
See also:
Zend_Soap_Client_Exception

Definition at line 807 of file Client.php.

Here is the caller graph for this function:

setStyle ( style)

Set request style

Parameters:
int$styleOne of the SOAP_RPC or SOAP_DOCUMENT constants
Returns:
Zend_Soap_Client
Exceptions:
Zend_Soap_Client_Exceptionwith invalid style argument

Definition at line 516 of file Client.php.

Here is the caller graph for this function:

setUri ( uri)

Set URI

URI in Web Service the target namespace

Parameters:
string$uri
Returns:
Zend_Soap_Client
Exceptions:
Zend_Soap_Client_Exceptionwith invalid uri argument

Definition at line 460 of file Client.php.

Here is the call graph for this function:

Here is the caller graph for this function:

setUserAgent ( userAgent)

Set the string to use in User-Agent header

Parameters:
string | null$userAgent
Returns:
Zend_Soap_Client

Definition at line 883 of file Client.php.

Here is the caller graph for this function:

setWsdl ( wsdl)

Set wsdl

Parameters:
string$wsdl
Returns:
Zend_Soap_Client

Definition at line 169 of file Client.php.

Here is the caller graph for this function:

setWsdlCache ( options)

Set the SOAP Wsdl Caching Options

Parameters:
string | int | boolean$caching
Returns:
Zend_Soap_Client

Definition at line 863 of file Client.php.

Here is the caller graph for this function:

validateUrn ( urn)

Check for valid URN

Parameters:
string$urn
Returns:
true
Exceptions:
Zend_Soap_Client_Exceptionon invalid URN

Definition at line 439 of file Client.php.

Here is the caller graph for this function:


Field Documentation

$_cache_wsdl = null [protected]

Definition at line 90 of file Client.php.

$_classmap = null [protected]

Definition at line 59 of file Client.php.

$_compression = null [protected]

Definition at line 86 of file Client.php.

$_connection_timeout = null [protected]

Definition at line 87 of file Client.php.

$_encoding = 'UTF-8' [protected]

Definition at line 53 of file Client.php.

$_faultExceptions = array() [protected]

Definition at line 65 of file Client.php.

$_features = null [protected]

Definition at line 89 of file Client.php.

$_lastMethod = '' [protected]

Definition at line 113 of file Client.php.

$_local_cert = null [protected]

Definition at line 84 of file Client.php.

$_location = null [protected]

Definition at line 75 of file Client.php.

$_login = null [protected]

Definition at line 78 of file Client.php.

$_passphrase = null [protected]

Definition at line 85 of file Client.php.

$_password = null [protected]

Definition at line 79 of file Client.php.

$_permanentSoapInputHeaders = array() [protected]

Definition at line 131 of file Client.php.

$_proxy_host = null [protected]

Definition at line 80 of file Client.php.

$_proxy_login = null [protected]

Definition at line 82 of file Client.php.

$_proxy_password = null [protected]

Definition at line 83 of file Client.php.

$_proxy_port = null [protected]

Definition at line 81 of file Client.php.

$_soapClient [protected]

Definition at line 106 of file Client.php.

$_soapInputHeaders = array() [protected]

Definition at line 122 of file Client.php.

$_soapOutputHeaders = array() [protected]

Definition at line 140 of file Client.php.

$_soapVersion = SOAP_1_2 [protected]

Definition at line 71 of file Client.php.

$_stream_context = null [protected]

Definition at line 88 of file Client.php.

$_style = null [protected]

Definition at line 76 of file Client.php.

$_uri = null [protected]

Set of other SoapClient options

Definition at line 74 of file Client.php.

$_use = null [protected]

Definition at line 77 of file Client.php.

$_user_agent = null [protected]

Definition at line 91 of file Client.php.

$_wsdl = null [protected]

Definition at line 99 of file Client.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations