API Documentation

Zend/Soap/Client.php

Show: inherited
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: Client.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Soap_Client

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotected  $_cache_wsdl= 'null'
Default valuenullDetails
Type
Propertyprotectedarray  $_classmap= 'null'

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

Default valuenullDetails
Type
array
Propertyprotected  $_compression= 'null'
Default valuenullDetails
Type
Propertyprotected  $_connection_timeout= 'null'
Default valuenullDetails
Type
Propertyprotectedstring  $_encoding= ''UTF-8''

Encoding

Default value'UTF-8'Details
Type
string
Propertyprotectedarray  $_faultExceptions= 'array()'

Registered fault exceptions

Default valuearray()Details
Type
array
Propertyprotected  $_features= 'null'
Default valuenullDetails
Type
Propertyprotectedstring  $_lastMethod= ''''

Last invoked method

Default value''Details
Type
string
Propertyprotected  $_local_cert= 'null'
Default valuenullDetails
Type
Propertyprotected  $_location= 'null'
Default valuenullDetails
Type
Propertyprotected  $_login= 'null'
Default valuenullDetails
Type
Propertyprotected  $_passphrase= 'null'
Default valuenullDetails
Type
Propertyprotected  $_password= 'null'
Default valuenullDetails
Type
Propertyprotectedarray  $_permanentSoapInputHeaders= 'array()'

Permanent SOAP request headers (shared between requests).

Array of SoapHeader objects

Default valuearray()Details
Type
array
Propertyprotected  $_proxy_host= 'null'
Default valuenullDetails
Type
Propertyprotected  $_proxy_login= 'null'
Default valuenullDetails
Type
Propertyprotected  $_proxy_password= 'null'
Default valuenullDetails
Type
Propertyprotected  $_proxy_port= 'null'
Default valuenullDetails
Type
Propertyprotected\SoapClient  $_soapClient= ''

SoapClient object

Details
Type
\SoapClient
Propertyprotectedarray  $_soapInputHeaders= 'array()'

SOAP request headers.

Array of SoapHeader objects

Default valuearray()Details
Type
array
Propertyprotectedarray  $_soapOutputHeaders= 'array()'

Output SOAP headers.

Array of SoapHeader objects

Default valuearray()Details
Type
array
Propertyprotectedint  $_soapVersion= 'SOAP_1_2'

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

Default valueSOAP_1_2Details
Type
int
Propertyprotected  $_stream_context= 'null'
Default valuenullDetails
Type
Propertyprotected  $_style= 'null'
Default valuenullDetails
Type
Propertyprotected  $_uri= 'null'

Set of other SoapClient options

Default valuenullDetails
Type
Propertyprotected  $_use= 'null'
Default valuenullDetails
Type
Propertyprotected  $_user_agent= 'null'
Default valuenullDetails
Type
Propertyprotectedstring  $_wsdl= 'null'

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

Default valuenullDetails
Type
string

Methods

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

Perform a SOAP call

Parameters
Name Type Description
$name string
$arguments array
Returns
Type Description
mixed
methodpublic__construct( string $wsdl = null, array $options = null ) : void

Constructor

Parameters
Name Type Description
$wsdl string
$options array
methodprotected_initSoapClientObject( ) : void

Initialize SOAP Client object

Throws
Exception Description
\Zend_Soap_Client_Exception
methodprotected_preProcessArguments( array $arguments ) : void

Perform arguments pre-processing

My be overridden in descendant classes

Parameters
Name Type Description
$arguments array
methodprotected_preProcessResult(  $result ) : void

Perform result pre-processing

My be overridden in descendant classes

Parameters
Name Type Description
$result
methodpublicaddSoapInputHeader( \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
methodpublicgetClassmap( ) : mixed

Retrieve classmap

Returns
Type Description
mixed
methodpublicgetCompressionOptions( ) : int

Get Compression options

Returns
Type Description
int
methodpublicgetEncoding( ) : string

Get encoding

Returns
Type Description
string
methodpublicgetEncodingMethod( ) : int

Get message encoding method

Returns
Type Description
int
methodpublicgetFunctions( ) : array

Return a list of available functions

Returns
Type Description
array
Throws
Exception Description
\Zend_Soap_Client_Exception
methodpublicgetHttpLogin( ) : string

Retrieve HTTP Login

Returns
Type Description
string
methodpublicgetHttpPassword( ) : string

Retrieve HTTP Password

Returns
Type Description
string
methodpublicgetHttpsCertPassphrase( ) : string

Get HTTPS client certificate passphrase

Returns
Type Description
string
methodpublicgetHttpsCertificate( ) : string

Get HTTPS client certificate path

Returns
Type Description
string
methodpublicgetLastMethod( ) : string

Retrieve last invoked method

Returns
Type Description
string
methodpublicgetLastRequest( ) : string

Retrieve request XML

Returns
Type Description
string
methodpublicgetLastRequestHeaders( ) : string

Retrieve request headers

Returns
Type Description
string
methodpublicgetLastResponse( ) : string

Get response XML

Returns
Type Description
string
methodpublicgetLastResponseHeaders( ) : string

Retrieve response headers (as string)

Returns
Type Description
string
methodpublicgetLastSoapOutputHeaderObjects( ) : array

Get last SOAP output headers

Returns
Type Description
array
methodpublicgetLocation( ) : string

Retrieve URI

Returns
Type Description
string
methodpublicgetOptions( ) : array

Return array of options suitable for using with SoapClient constructor

Returns
Type Description
array
methodpublicgetProxyHost( ) : string

Retrieve proxy host

Returns
Type Description
string
methodpublicgetProxyLogin( ) : string

Retrieve proxy login

Returns
Type Description
string
methodpublicgetProxyPassword( ) : string

Retrieve proxy password

Returns
Type Description
string
methodpublicgetProxyPort( ) : int

Retrieve proxy port

Returns
Type Description
int
methodpublicgetSoapClient( ) : \SoapClient

Returns
Type Description
\SoapClient
methodpublicgetSoapFeatures( ) : int

Return current SOAP Features options

Returns
Type Description
int
methodpublicgetSoapVersion( ) : int

Get SOAP version

Returns
Type Description
int
methodpublicgetStreamContext( ) : resource

Get Stream Context

Returns
Type Description
resource
methodpublicgetStyle( ) : int

Get request style

Returns
Type Description
int
methodpublicgetTypes( ) : array

Return a list of SOAP types

Returns
Type Description
array
Throws
Exception Description
\Zend_Soap_Client_Exception
methodpublicgetUri( ) : string

Retrieve URI

Returns
Type Description
string
methodpublicgetUserAgent( ) : string|null

Get current string to use in User-Agent header

Returns
Type Description
string|null
methodpublicgetWsdl( ) : string

Get wsdl

Returns
Type Description
string
methodpublicgetWsdlCache( ) : int

Get current SOAP Wsdl Caching option

Returns
Type Description
int
methodpublicresetSoapInputHeaders( ) : \Zend_Soap_Client

Reset SOAP input headers

Returns
Type Description
\Zend_Soap_Client
methodpublicsetClassmap( 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
methodpublicsetCompressionOptions( int|null $compressionOptions ) : \Zend_Soap_Client

Set compression options

Parameters
Name Type Description
$compressionOptions int|null
Returns
Type Description
\Zend_Soap_Client
methodpublicsetCookie(  $cookieName,  $cookieValue = null ) : \Zend_Soap_Client

Parameters
Name Type Description
$cookieName
$cookieValue
Returns
Type Description
\Zend_Soap_Client
methodpublicsetEncoding( 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
methodpublicsetEncodingMethod( 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
methodpublicsetHttpLogin( string $login ) : \Zend_Soap_Client

Set HTTP login

Parameters
Name Type Description
$login string
Returns
Type Description
\Zend_Soap_Client
methodpublicsetHttpPassword( string $password ) : \Zend_Soap_Client

Set HTTP password

Parameters
Name Type Description
$password string
Returns
Type Description
\Zend_Soap_Client
methodpublicsetHttpsCertPassphrase( string $passphrase ) : \Zend_Soap_Client

Set HTTPS client certificate passphrase

Parameters
Name Type Description
$passphrase string
Returns
Type Description
\Zend_Soap_Client
methodpublicsetHttpsCertificate( 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
methodpublicsetLocation( 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
methodpublicsetOptions( 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
methodpublicsetProxyHost( string $proxyHost ) : \Zend_Soap_Client

Set proxy host

Parameters
Name Type Description
$proxyHost string
Returns
Type Description
\Zend_Soap_Client
methodpublicsetProxyLogin( string $proxyLogin ) : \Zend_Soap_Client

Set proxy login

Parameters
Name Type Description
$proxyLogin string
Returns
Type Description
\Zend_Soap_Client
methodpublicsetProxyPassword(  $proxyPassword ) : \Zend_Soap_Client

Set proxy password

Parameters
Name Type Description
$proxyPassword
Returns
Type Description
\Zend_Soap_Client
methodpublicsetProxyPort( int $proxyPort ) : \Zend_Soap_Client

Set proxy port

Parameters
Name Type Description
$proxyPort int
Returns
Type Description
\Zend_Soap_Client
methodpublicsetSoapClient( \SoapClient $soapClient ) : \Zend_Soap_Client

Parameters
Name Type Description
$soapClient \SoapClient
Returns
Type Description
\Zend_Soap_Client
methodpublicsetSoapFeatures( string|int $feature ) : \Zend_Soap_Client

Set the SOAP Feature options.

Parameters
Name Type Description
$feature string|int
Returns
Type Description
\Zend_Soap_Client
methodpublicsetSoapVersion( 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
methodpublicsetStreamContext(  $context ) : \Zend_Soap_Client

Set Stream Context

Parameters
Name Type Description
$context
Returns
Type Description
\Zend_Soap_Client
methodpublicsetStyle( 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
methodpublicsetUri( 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
methodpublicsetUserAgent( 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
methodpublicsetWsdl( string $wsdl ) : \Zend_Soap_Client

Set wsdl

Parameters
Name Type Description
$wsdl string
Returns
Type Description
\Zend_Soap_Client
methodpublicsetWsdlCache( 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
methodpublicvalidateUrn( 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
Documentation was generated by DocBlox 0.15.1.