Service/DeveloperGarden/Client/Soap.php
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 [email protected] 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_Service
- Subpackage
- DeveloperGarden
- Version
- $Id: Soap.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Service_DeveloperGarden_Client_Soap
Zend_Soap_Client
- Parent(s)
- \Zend_Soap_Client
- Author
- Marco Kaiser
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants
string
WSSE_NAMESPACE_SECEXT
= 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd'WSSE Security Ext Namespace
- string
Properties

$_cache_wsdl = nullnullDetails- Type
- n/a
- Inherited_from
- \Zend_Soap_Client::$$_cache_wsdl

array $_classmap = nullArray of SOAP type => PHP class pairings for handling return/incoming values
Inherited from: \Zend_Soap_Client::$$_classmapnullDetails- Type
- array
- Inherited_from
- \Zend_Soap_Client::$$_classmap

$_compression = nullnullDetails- Type
- n/a
- Inherited_from
- \Zend_Soap_Client::$$_compression

$_connection_timeout = nullnullDetails- Type
- n/a
- Inherited_from
- \Zend_Soap_Client::$$_connection_timeout

\Zend_Service_DeveloperGarden_Credential $_credential = nullclass with credential interface
nullDetails

string $_encoding = 'UTF-8'
'UTF-8'Details- Type
- string
- Inherited_from
- \Zend_Soap_Client::$$_encoding

array $_faultExceptions = array()
array()Details- Type
- array
- Inherited_from
- \Zend_Soap_Client::$$_faultExceptions

$_features = nullnullDetails- Type
- n/a
- Inherited_from
- \Zend_Soap_Client::$$_features

string $_lastMethod = ''
''Details- Type
- string
- Inherited_from
- \Zend_Soap_Client::$$_lastMethod

$_local_cert = nullnullDetails- Type
- n/a
- Inherited_from
- \Zend_Soap_Client::$$_local_cert

$_location = nullnullDetails- Type
- n/a
- Inherited_from
- \Zend_Soap_Client::$$_location

$_login = nullnullDetails- Type
- n/a
- Inherited_from
- \Zend_Soap_Client::$$_login

$_passphrase = nullnullDetails- Type
- n/a
- Inherited_from
- \Zend_Soap_Client::$$_passphrase

$_password = nullnullDetails- Type
- n/a
- Inherited_from
- \Zend_Soap_Client::$$_password

array $_permanentSoapInputHeaders = array()Permanent SOAP request headers (shared between requests).
Inherited from: \Zend_Soap_Client::$$_permanentSoapInputHeadersArray of SoapHeader objects
array()Details- Type
- array
- Inherited_from
- \Zend_Soap_Client::$$_permanentSoapInputHeaders

$_proxy_host = nullnullDetails- Type
- n/a
- Inherited_from
- \Zend_Soap_Client::$$_proxy_host

$_proxy_login = nullnullDetails- Type
- n/a
- Inherited_from
- \Zend_Soap_Client::$$_proxy_login

$_proxy_password = nullnullDetails- Type
- n/a
- Inherited_from
- \Zend_Soap_Client::$$_proxy_password

$_proxy_port = nullnullDetails- Type
- n/a
- Inherited_from
- \Zend_Soap_Client::$$_proxy_port

array $_soapInputHeaders = array()
Array of SoapHeader objects
array()Details- Type
- array
- Inherited_from
- \Zend_Soap_Client::$$_soapInputHeaders

array $_soapOutputHeaders = array()
Array of SoapHeader objects
array()Details- Type
- array
- Inherited_from
- \Zend_Soap_Client::$$_soapOutputHeaders

int $_soapVersion = SOAP_1_2SOAP version to use; SOAP_1_2 by default, to allow processing of headers
Inherited from: \Zend_Soap_Client::$$_soapVersionSOAP_1_2Details- Type
- int
- Inherited_from
- \Zend_Soap_Client::$$_soapVersion

$_stream_context = nullnullDetails- Type
- n/a
- Inherited_from
- \Zend_Soap_Client::$$_stream_context

$_style = nullnullDetails- Type
- n/a
- Inherited_from
- \Zend_Soap_Client::$$_style

\Zend_Service_DeveloperGarden_SecurityTokenServer $_tokenService = nullis this client used by the token service
nullDetails

$_use = nullnullDetails- Type
- n/a
- Inherited_from
- \Zend_Soap_Client::$$_use

$_user_agent = nullnullDetails- Type
- n/a
- Inherited_from
- \Zend_Soap_Client::$$_user_agent

string $_wsdl = nullWSDL used to access server It also defines Zend_Soap_Client working mode (WSDL vs non-WSDL)
Inherited from: \Zend_Soap_Client::$$_wsdlnullDetails- Type
- string
- Inherited_from
- \Zend_Soap_Client::$$_wsdl
Methods

__call(string $name, array $arguments) : mixedPerform a SOAP call but first check for adding STS Token or fetch one
| Name | Type | Description |
|---|---|---|
| $name | string | |
| $arguments | array |
| Type | Description |
|---|---|
| mixed |

__construct(string $wsdl = null, array $options = null) : void
| Name | Type | Description |
|---|---|---|
| $wsdl | string | |
| $options | array |

_preProcessArguments(array $arguments) : void
My be overridden in descendant classes
| Name | Type | Description |
|---|---|---|
| $arguments | array |

_preProcessResult( $result) : void
My be overridden in descendant classes
| Name | Type | Description |
|---|---|---|
| $result |

addSoapInputHeader(\SoapHeader $header, boolean $permanent = false) : \Zend_Soap_Client
| Name | Type | Description |
|---|---|---|
| $header | \SoapHeader | |
| $permanent | boolean |
| Type | Description |
|---|---|
| \Zend_Soap_Client |

addWsseLoginHeader() : \Zend_Service_DeveloperGarden_Client_Soapadds the login specific header to the client
| Type | Description |
|---|---|
| \Zend_Service_DeveloperGarden_Client_Soap |

addWsseSecurityTokenHeader(\Zend_Service_DeveloperGarden_Response_SecurityTokenServer_SecurityTokenResponse $token) : \Zend_Service_DeveloperGarden_Client_Soapadds the earlier fetched token to the header
| Name | Type | Description |
|---|---|---|
| $token | \Zend_Service_DeveloperGarden_Response_SecurityTokenServer_SecurityTokenResponse |
| Type | Description |
|---|---|
| \Zend_Service_DeveloperGarden_Client_Soap |

addWsseTokenHeader(\Zend_Service_DeveloperGarden_Response_SecurityTokenServer_SecurityTokenResponse $token) : \Zend_Service_DeveloperGarden_Client_Soapadds the earlier fetched token to the header
| Name | Type | Description |
|---|---|---|
| $token | \Zend_Service_DeveloperGarden_Response_SecurityTokenServer_SecurityTokenResponse |
| Type | Description |
|---|---|
| \Zend_Service_DeveloperGarden_Client_Soap |

getCredential() : \Zend_Service_DeveloperGarden_Credentialreturns the internal credential callback object
| Type | Description |
|---|---|
| \Zend_Service_DeveloperGarden_Credential |

getFunctions() : array
| Type | Description |
|---|---|
| array |
| Exception | Description |
|---|---|
| \Zend_Soap_Client_Exception |

getHttpsCertPassphrase() : stringGet HTTPS client certificate passphrase
Inherited from: \Zend_Soap_Client::getHttpsCertPassphrase()| Type | Description |
|---|---|
| string |

getLastResponseHeaders() : stringRetrieve response headers (as string)
Inherited from: \Zend_Soap_Client::getLastResponseHeaders()| Type | Description |
|---|---|
| string |

getLastSoapOutputHeaderObjects() : arrayGet last SOAP output headers
Inherited from: \Zend_Soap_Client::getLastSoapOutputHeaderObjects()| Type | Description |
|---|---|
| array |

getOptions() : arrayReturn array of options suitable for using with SoapClient constructor
Inherited from: \Zend_Soap_Client::getOptions()| Type | Description |
|---|---|
| array |

getSoapClient() : \SoapClient| Type | Description |
|---|---|
| \SoapClient |

getTokenService() : \Zend_Service_DeveloperGarden_SecurityTokenServerreturns the currently configured tokenService object
| Type | Description |
|---|---|
| \Zend_Service_DeveloperGarden_SecurityTokenServer |

getTypes() : array
| Type | Description |
|---|---|
| array |
| Exception | Description |
|---|---|
| \Zend_Soap_Client_Exception |

getUserAgent() : string | nullGet current string to use in User-Agent header
Inherited from: \Zend_Soap_Client::getUserAgent()| Type | Description |
|---|---|
| string | null |

getWsseLoginHeader() : \SoapHeadercreates the login header and add
| Type | Description |
|---|---|
| \SoapHeader |

getWsseSecurityTokenHeader(\Zend_Service_DeveloperGarden_Response_SecurityTokenServer_SecurityTokenResponse $token) : \SoapHeadercreates the security token auth header for direct calls
| Name | Type | Description |
|---|---|---|
| $token | \Zend_Service_DeveloperGarden_Response_SecurityTokenServer_SecurityTokenResponse |
| Type | Description |
|---|---|
| \SoapHeader |

getWsseTokenHeader(\Zend_Service_DeveloperGarden_Response_SecurityTokenServer_SecurityTokenResponse $token) : \SoapHeadercreates the token auth header for direct calls
| Name | Type | Description |
|---|---|---|
| $token | \Zend_Service_DeveloperGarden_Response_SecurityTokenServer_SecurityTokenResponse |
| Type | Description |
|---|---|
| \SoapHeader |

setClassmap(array $classmap) : \Zend_Soap_Client
| Name | Type | Description |
|---|---|---|
| $classmap | array |
| Type | Description |
|---|---|
| \Zend_Soap_Client |
| Exception | Description |
|---|---|
| \Zend_Soap_Client_Exception | for any invalid class in the class map |

setCompressionOptions(int | null $compressionOptions) : \Zend_Soap_Client
| Name | Type | Description |
|---|---|---|
| $compressionOptions | int | null |
| Type | Description |
|---|---|
| \Zend_Soap_Client |

setCookie( $cookieName, $cookieValue = null) : \Zend_Soap_Client| Name | Type | Description |
|---|---|---|
| $cookieName | ||
| $cookieValue |
| Type | Description |
|---|---|
| \Zend_Soap_Client |

setCredential(\Zend_Service_DeveloperGarden_Credential $credential) : \Zend_Service_DeveloperGarden_Client_SoapSets new credential callback object
| Name | Type | Description |
|---|---|---|
| $credential | \Zend_Service_DeveloperGarden_Credential |
| Type | Description |
|---|---|
| \Zend_Service_DeveloperGarden_Client_Soap |

setEncoding(string $encoding) : \Zend_Soap_Client
| Name | Type | Description |
|---|---|---|
| $encoding | string |
| Type | Description |
|---|---|
| \Zend_Soap_Client |
| Exception | Description |
|---|---|
| \Zend_Soap_Client_Exception | with invalid encoding argument |

setEncodingMethod(int $use) : \Zend_Soap_Client
| Name | Type | Description |
|---|---|---|
| $use | int | One of the SOAP_ENCODED or SOAP_LITERAL constants |
| Type | Description |
|---|---|
| \Zend_Soap_Client |
| Exception | Description |
|---|---|
| \Zend_Soap_Client_Exception | with invalid message encoding method argument |

setHttpLogin(string $login) : \Zend_Soap_Client
| Name | Type | Description |
|---|---|---|
| $login | string |
| Type | Description |
|---|---|
| \Zend_Soap_Client |

setHttpPassword(string $password) : \Zend_Soap_Client
| Name | Type | Description |
|---|---|---|
| $password | string |
| Type | Description |
|---|---|
| \Zend_Soap_Client |

setHttpsCertPassphrase(string $passphrase) : \Zend_Soap_ClientSet HTTPS client certificate passphrase
Inherited from: \Zend_Soap_Client::setHttpsCertPassphrase()| Name | Type | Description |
|---|---|---|
| $passphrase | string |
| Type | Description |
|---|---|
| \Zend_Soap_Client |

setHttpsCertificate(string $localCert) : \Zend_Soap_Client
| Name | Type | Description |
|---|---|---|
| $localCert | string | local certificate path |
| Type | Description |
|---|---|
| \Zend_Soap_Client |
| Exception | Description |
|---|---|
| \Zend_Soap_Client_Exception | with invalid local certificate path argument |

setLocation(string $location) : \Zend_Soap_Client
URI in Web Service the target namespace
| Name | Type | Description |
|---|---|---|
| $location | string |
| Type | Description |
|---|---|
| \Zend_Soap_Client |
| Exception | Description |
|---|---|
| \Zend_Soap_Client_Exception | with invalid uri argument |

setOptions(array | \Zend_Config $options) : \Zend_Soap_Client
Allows setting options as an associative array of option => value pairs.
| Name | Type | Description |
|---|---|---|
| $options | array | \Zend_Config |
| Type | Description |
|---|---|
| \Zend_Soap_Client |
| Exception | Description |
|---|---|
| \Zend_SoapClient_Exception |

setProxyHost(string $proxyHost) : \Zend_Soap_Client
| Name | Type | Description |
|---|---|---|
| $proxyHost | string |
| Type | Description |
|---|---|
| \Zend_Soap_Client |

setProxyLogin(string $proxyLogin) : \Zend_Soap_Client
| Name | Type | Description |
|---|---|---|
| $proxyLogin | string |
| Type | Description |
|---|---|
| \Zend_Soap_Client |

setProxyPassword( $proxyPassword) : \Zend_Soap_Client
| Name | Type | Description |
|---|---|---|
| $proxyPassword |
| Type | Description |
|---|---|
| \Zend_Soap_Client |

setProxyPort(int $proxyPort) : \Zend_Soap_Client
| Name | Type | Description |
|---|---|---|
| $proxyPort | int |
| Type | Description |
|---|---|
| \Zend_Soap_Client |

setSoapClient(\SoapClient $soapClient) : \Zend_Soap_Client| Name | Type | Description |
|---|---|---|
| $soapClient | \SoapClient |
| Type | Description |
|---|---|
| \Zend_Soap_Client |

setSoapFeatures(string | int $feature) : \Zend_Soap_Client
| Name | Type | Description |
|---|---|---|
| $feature | string | int |
| Type | Description |
|---|---|
| \Zend_Soap_Client |

setSoapVersion(int $version) : \Zend_Soap_Client
| Name | Type | Description |
|---|---|---|
| $version | int | One of the SOAP_1_1 or SOAP_1_2 constants |
| Type | Description |
|---|---|
| \Zend_Soap_Client |
| Exception | Description |
|---|---|
| \Zend_Soap_Client_Exception | with invalid soap version argument |

setStreamContext( $context) : \Zend_Soap_Client
| Name | Type | Description |
|---|---|---|
| $context |
| Type | Description |
|---|---|
| \Zend_Soap_Client |

setStyle(int $style) : \Zend_Soap_Client
| Name | Type | Description |
|---|---|---|
| $style | int | One of the SOAP_RPC or SOAP_DOCUMENT constants |
| Type | Description |
|---|---|
| \Zend_Soap_Client |
| Exception | Description |
|---|---|
| \Zend_Soap_Client_Exception | with invalid style argument |

setTokenService( $tokenService) : \Zend_Service_DeveloperGarden_Client_Soapsets the internal handling for handle token service
| Name | Type | Description |
|---|---|---|
| $tokenService |
| Type | Description |
|---|---|
| \Zend_Service_DeveloperGarden_Client_Soap |

setUri(string $uri) : \Zend_Soap_Client
URI in Web Service the target namespace
| Name | Type | Description |
|---|---|---|
| $uri | string |
| Type | Description |
|---|---|
| \Zend_Soap_Client |
| Exception | Description |
|---|---|
| \Zend_Soap_Client_Exception | with invalid uri argument |

setUserAgent(string | null $userAgent) : \Zend_Soap_ClientSet the string to use in User-Agent header
Inherited from: \Zend_Soap_Client::setUserAgent()| Name | Type | Description |
|---|---|---|
| $userAgent | string | null |
| Type | Description |
|---|---|
| \Zend_Soap_Client |

setWsdl(string $wsdl) : \Zend_Soap_Client
| Name | Type | Description |
|---|---|---|
| $wsdl | string |
| Type | Description |
|---|---|
| \Zend_Soap_Client |

setWsdlCache(string | int | boolean | null $caching) : \Zend_Soap_Client
| Name | Type | Description |
|---|---|---|
| $caching | string | int | boolean | null |
| Type | Description |
|---|---|
| \Zend_Soap_Client |

validateUrn(string $urn) : true
| Name | Type | Description |
|---|---|---|
| $urn | string |
| Type | Description |
|---|---|
| true |
| Exception | Description |
|---|---|
| \Zend_Soap_Client_Exception | on invalid URN |