Zend_Soap_Client Class Reference

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 ($caching)
	getWsdlCache ()
	setUserAgent ($userAgent)
	getUserAgent ()
	setExceptions ($exceptions)
	getExceptions ()
	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
	$_exceptions = 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()

__construct	(		$wsdl = null,
			$options = null
	)

Constructor

Parameters

string	$wsdl
array	$options

Definition at line 149 of file Client.php.

    {
        if (!extension_loaded('soap')) {
            #require_once 'Zend/Soap/Client/Exception.php';
            throw new Zend_Soap_Client_Exception('SOAP extension is not loaded.');
        }

        if ($wsdl !== null) {
            $this->setWsdl($wsdl);
        }
        if ($options !== null) {
            $this->setOptions($options);
        }
    }

Member Function Documentation

__call()

__call	(		$name,
			$arguments
	)

Perform a SOAP call

Parameters

string	$name
array	$arguments

Returns

mixed

Definition at line 1148 of file Client.php.

    {
        $soapClient = $this->getSoapClient();

        $this->_lastMethod = $name;

        $soapHeaders = array_merge($this->_permanentSoapInputHeaders, $this->_soapInputHeaders);
        $result = $soapClient->__soapCall($name,
                                                 $this->_preProcessArguments($arguments),
                                                 null, /* Options are already set to the SOAP client object */
                                                 (count($soapHeaders) > 0)? $soapHeaders : null,
                                                 $this->_soapOutputHeaders);

        // Reset non-permanent input headers
        $this->_soapInputHeaders = array();

        return $this->_preProcessResult($result);
    }

_doRequest()

_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 1029 of file Client.php.

    {
        // Perform request as is
        if ($one_way == null) {
            return call_user_func(array($client,'SoapClient::__doRequest'), $request, $location, $action, $version);
        } else {
            return call_user_func(array($client,'SoapClient::__doRequest'), $request, $location, $action, $version, $one_way);
        }
    }

_initSoapClientObject()

_initSoapClientObject ( )

protected

Initialize SOAP Client object

Exceptions

Zend_Soap_Client_Exception

Definition at line 1044 of file Client.php.

    {
        $wsdl = $this->getWsdl();
        $options = array_merge($this->getOptions(), array('trace' => true));

        if ($wsdl == null) {
            if (!isset($options['location'])) {
                #require_once 'Zend/Soap/Client/Exception.php';
                throw new Zend_Soap_Client_Exception('\'location\' parameter is required in non-WSDL mode.');
            }
            if (!isset($options['uri'])) {
                #require_once 'Zend/Soap/Client/Exception.php';
                throw new Zend_Soap_Client_Exception('\'uri\' parameter is required in non-WSDL mode.');
            }
        } else {
            if (isset($options['use'])) {
                #require_once 'Zend/Soap/Client/Exception.php';
                throw new Zend_Soap_Client_Exception('\'use\' parameter only works in non-WSDL mode.');
            }
            if (isset($options['style'])) {
                #require_once 'Zend/Soap/Client/Exception.php';
                throw new Zend_Soap_Client_Exception('\'style\' parameter only works in non-WSDL mode.');
            }
        }
        unset($options['wsdl']);

        $this->_soapClient = new Zend_Soap_Client_Common(array($this, '_doRequest'), $wsdl, $options);
    }

_preProcessArguments()

_preProcessArguments (   $arguments )

protected

Perform arguments pre-processing

My be overridden in descendant classes

Parameters

array

$arguments

Definition at line 1081 of file Client.php.

    {
        // Do nothing
        return $arguments;
    }

_preProcessResult()

_preProcessResult (   $result )

protected

Perform result pre-processing

My be overridden in descendant classes

Parameters

array

$arguments

Definition at line 1094 of file Client.php.

    {
        // Do nothing
        return $result;
    }

addSoapInputHeader()

addSoapInputHeader	(	SoapHeader	$header,
			$permanent = false
	)

Add SOAP input header

Parameters

SoapHeader	$header
boolean	$permanent

Returns

Zend_Soap_Client

Definition at line 1107 of file Client.php.

    {
        if ($permanent) {
            $this->_permanentSoapInputHeaders[] = $header;
        } else {
            $this->_soapInputHeaders[] = $header;
        }

        return $this;
    }

getClassmap()

getClassmap

(

)

Retrieve classmap

Returns

mixed

Definition at line 401 of file Client.php.

    {
        return $this->_classmap;
    }

getCompressionOptions()

getCompressionOptions

(

)

Get Compression options

Returns

int

Definition at line 794 of file Client.php.

    {
        return $this->_compression;
    }

getEncoding()

getEncoding

(

)

Get encoding

Returns

string

Definition at line 432 of file Client.php.

    {
        return $this->_encoding;
    }

getEncodingMethod()

getEncodingMethod

(

)

Get message encoding method

Returns

int

Definition at line 571 of file Client.php.

    {
        return $this->_use;
    }

getExceptions()

getExceptions

(

)

Get the exceptions option

The exceptions option is a boolean value defining whether soap errors throw exceptions.

See also

http://php.net/manual/soapclient.soapclient.php#refsect1-soapclient.soapclient-parameters

Returns

bool|null

Definition at line 944 of file Client.php.

    {
        return $this->_exceptions;
    }

getFunctions()

getFunctions

(

)

Return a list of available functions

Returns

array

Exceptions

Zend_Soap_Client_Exception

Definition at line 1174 of file Client.php.

    {
        if ($this->getWsdl() == null) {
            #require_once 'Zend/Soap/Client/Exception.php';
            throw new Zend_Soap_Client_Exception('\'getFunctions\' method is available only in WSDL mode.');
        }

        $soapClient = $this->getSoapClient();
        return $soapClient->__getFunctions();
    }

getHttpLogin()

getHttpLogin

(

)

Retrieve HTTP Login

Returns

string

Definition at line 596 of file Client.php.

    {
        return $this->_login;
    }

getHttpPassword()

getHttpPassword

(

)

Retrieve HTTP Password

Returns

string

Definition at line 621 of file Client.php.

    {
        return $this->_password;
    }

getHttpsCertificate()

getHttpsCertificate

(

)

Get HTTPS client certificate path

Returns

string

Definition at line 742 of file Client.php.

    {
        return $this->_local_cert;
    }

getHttpsCertPassphrase()

getHttpsCertPassphrase

(

)

Get HTTPS client certificate passphrase

Returns

string

Definition at line 767 of file Client.php.

    {
        return $this->_passphrase;
    }

getLastMethod()

getLastMethod

(

)

Retrieve last invoked method

Returns

string

Definition at line 1010 of file Client.php.

    {
        return $this->_lastMethod;
    }

getLastRequest()

getLastRequest

(

)

Retrieve request XML

Returns

string

Definition at line 954 of file Client.php.

    {
        if ($this->_soapClient !== null) {
            return $this->_soapClient->__getLastRequest();
        }

        return '';
    }

getLastRequestHeaders()

getLastRequestHeaders

(

)

Retrieve request headers

Returns

string

Definition at line 982 of file Client.php.

    {
        if ($this->_soapClient !== null) {
            return $this->_soapClient->__getLastRequestHeaders();
        }

        return '';
    }

getLastResponse()

getLastResponse

(

)

Get response XML

Returns

string

Definition at line 968 of file Client.php.

    {
        if ($this->_soapClient !== null) {
            return $this->_soapClient->__getLastResponse();
        }

        return '';
    }

getLastResponseHeaders()

getLastResponseHeaders

(

)

Retrieve response headers (as string)

Returns

string

Definition at line 996 of file Client.php.

    {
        if ($this->_soapClient !== null) {
            return $this->_soapClient->__getLastResponseHeaders();
        }

        return '';
    }

getLastSoapOutputHeaderObjects()

getLastSoapOutputHeaderObjects

(

)

Get last SOAP output headers

Returns

array

Definition at line 1136 of file Client.php.

    {
        return $this->_soapOutputHeaders;
    }

getLocation()

getLocation

(

)

Retrieve URI

Returns

string

Definition at line 509 of file Client.php.

    {
        return $this->_location;
    }

getOptions()

getOptions

(

)

Return array of options suitable for using with SoapClient constructor

Returns

array

Definition at line 296 of file Client.php.

    {
        $options = array();

        $options['classmap']       = $this->getClassmap();
        $options['encoding']       = $this->getEncoding();
        $options['soap_version']   = $this->getSoapVersion();
        $options['wsdl']           = $this->getWsdl();
        $options['uri']            = $this->getUri();
        $options['location']       = $this->getLocation();
        $options['style']          = $this->getStyle();
        $options['use']            = $this->getEncodingMethod();
        $options['login']          = $this->getHttpLogin();
        $options['password']       = $this->getHttpPassword();
        $options['proxy_host']     = $this->getProxyHost();
        $options['proxy_port']     = $this->getProxyPort();
        $options['proxy_login']    = $this->getProxyLogin();
        $options['proxy_password'] = $this->getProxyPassword();
        $options['local_cert']     = $this->getHttpsCertificate();
        $options['passphrase']     = $this->getHttpsCertPassphrase();
        $options['compression']    = $this->getCompressionOptions();
        //$options['connection_timeout'] = $this->_connection_timeout;
        $options['stream_context'] = $this->getStreamContext();
        $options['cache_wsdl']     = $this->getWsdlCache();
        $options['features']       = $this->getSoapFeatures();
        $options['user_agent']     = $this->getUserAgent();
        $options['exceptions']     = $this->getExceptions();

        foreach ($options as $key => $value) {
            /*
             * ugly hack as I don't know if checking for '=== null'
             * breaks some other option
             */
            if (in_array($key, array('user_agent', 'cache_wsdl', 'compression', 'exceptions'))) {
                if ($value === null) {
                    unset($options[$key]);
                }
            } else {
                if ($value == null) {
                    unset($options[$key]);
                }
            }
        }

        return $options;
    }

getProxyHost()

getProxyHost

(

)

Retrieve proxy host

Returns

string

Definition at line 646 of file Client.php.

    {
        return $this->_proxy_host;
    }

getProxyLogin()

getProxyLogin

(

)

Retrieve proxy login

Returns

string

Definition at line 696 of file Client.php.

    {
        return $this->_proxy_login;
    }

getProxyPassword()

getProxyPassword

(

)

Retrieve proxy password

Returns

string

Definition at line 804 of file Client.php.

    {
        return $this->_proxy_password;
    }

getProxyPort()

getProxyPort

(

)

Retrieve proxy port

Returns

int

Definition at line 671 of file Client.php.

    {
        return $this->_proxy_port;
    }

getSoapClient()

getSoapClient

(

)

Returns

SoapClient

Definition at line 1223 of file Client.php.

    {
        if ($this->_soapClient == null) {
            $this->_initSoapClientObject();
        }
        return $this->_soapClient;
    }

getSoapFeatures()

getSoapFeatures

(

)

Return current SOAP Features options

Returns

int

Definition at line 859 of file Client.php.

    {
        return $this->_features;
    }

getSoapVersion()

getSoapVersion

(

)

Get SOAP version

Returns

int

Definition at line 368 of file Client.php.

    {
        return $this->_soapVersion;
    }

getStreamContext()

getStreamContext

(

)

Get Stream Context

Returns

resource

Definition at line 835 of file Client.php.

    {
        return $this->_stream_context;
    }

getStyle()

getStyle

(

)

Get request style

Returns

int

Definition at line 540 of file Client.php.

    {
        return $this->_style;
    }

getTypes()

getTypes

(

)

Get used types.

Returns

arrayReturn a list of SOAP types

array

Exceptions

Zend_Soap_Client_Exception

Definition at line 1198 of file Client.php.

    {
        if ($this->getWsdl() == null) {
            #require_once 'Zend/Soap/Client/Exception.php';
            throw new Zend_Soap_Client_Exception('\'getTypes\' method is available only in WSDL mode.');
        }

        $soapClient = $this->getSoapClient();

        return $soapClient->__getTypes();
    }

getUri()

getUri

(

)

Retrieve URI

Returns

string

Definition at line 480 of file Client.php.

    {
        return $this->_uri;
    }

getUserAgent()

getUserAgent

(

)

Get current string to use in User-Agent header

Returns

string|null

Definition at line 911 of file Client.php.

    {
        return $this->_user_agent;
    }

getWsdl()

getWsdl

(

)

Get wsdl

Returns

string

Definition at line 183 of file Client.php.

    {
        return $this->_wsdl;
    }

getWsdlCache()

getWsdlCache

(

)

Get current SOAP Wsdl Caching option

Returns

int

Definition at line 885 of file Client.php.

    {
        return $this->_cache_wsdl;
    }

resetSoapInputHeaders()

resetSoapInputHeaders

(

)

Reset SOAP input headers

Returns

Zend_Soap_Client

Definition at line 1123 of file Client.php.

    {
        $this->_permanentSoapInputHeaders = array();
        $this->_soapInputHeaders = array();

        return $this;
    }

setClassmap()

setClassmap

(

array

$classmap

)

Set classmap

Parameters

array

$classmap

Returns

Zend_Soap_Client

Exceptions

Zend_Soap_Client_Exception

for any invalid class in the class map

Definition at line 380 of file Client.php.

    {
        foreach ($classmap as $type => $class) {
            if (!class_exists($class)) {
                #require_once 'Zend/Soap/Client/Exception.php';
                throw new Zend_Soap_Client_Exception('Invalid class in class map');
            }
        }

        $this->_classmap = $classmap;

        $this->_soapClient = null;

        return $this;
    }

setCompressionOptions()

setCompressionOptions

(

$compressionOptions

)

Set compression options

Parameters

int | null

$compressionOptions

Returns

Zend_Soap_Client

Definition at line 778 of file Client.php.

    {
        if ($compressionOptions === null) {
            $this->_compression = null;
        } else {
            $this->_compression = (int)$compressionOptions;
        }
        $this->_soapClient = null;
        return $this;
    }

setCookie()

setCookie	(		$cookieName,
			$cookieValue = null
	)

Parameters

string	$name
string	$value

Returns

Zend_Soap_Client

Definition at line 1236 of file Client.php.

    {
        $soapClient = $this->getSoapClient();
        $soapClient->__setCookie($cookieName, $cookieValue);
        return $this;
    }

setEncoding()

setEncoding

(

$encoding

)

Set encoding

Parameters

string

$encoding

Returns

Zend_Soap_Client

Exceptions

Zend_Soap_Client_Exception

with invalid encoding argument

Definition at line 413 of file Client.php.

    {
        if (!is_string($encoding)) {
            #require_once 'Zend/Soap/Client/Exception.php';
            throw new Zend_Soap_Client_Exception('Invalid encoding specified');
        }

        $this->_encoding = $encoding;

        $this->_soapClient = null;

        return $this;
    }

setEncodingMethod()

setEncodingMethod

(

$use

)

Set message encoding method

Parameters

int

$use

One of the SOAP_ENCODED or SOAP_LITERAL constants

Returns

Zend_Soap_Client

Exceptions

Zend_Soap_Client_Exception

with invalid message encoding method argument

Definition at line 552 of file Client.php.

    {
        if (!in_array($use, array(SOAP_ENCODED, SOAP_LITERAL))) {
            #require_once 'Zend/Soap/Client/Exception.php';
            throw new Zend_Soap_Client_Exception('Invalid message encoding method. Use SOAP_ENCODED or SOAP_LITERAL constants.');
        }

        $this->_use = $use;

        $this->_soapClient = null;

        return $this;
    }

setExceptions()

setExceptions

(

$exceptions

)

Set the exceptions option

The exceptions option is a boolean value defining whether soap errors throw exceptions.

See also

http://php.net/manual/soapclient.soapclient.php#refsect1-soapclient.soapclient-parameters

Parameters

bool

$exceptions

Returns

$this

Definition at line 927 of file Client.php.

    {
        $this->_exceptions = (bool) $exceptions;

        return $this;
    }

setHttpLogin()

setHttpLogin

(

$login

)

Set HTTP login

Parameters

string

$login

Returns

Zend_Soap_Client

Definition at line 582 of file Client.php.

    {
        $this->_login = $login;

        $this->_soapClient = null;

        return $this;
    }

setHttpPassword()

setHttpPassword

(

$password

)

Set HTTP password

Parameters

string

$password

Returns

Zend_Soap_Client

Definition at line 607 of file Client.php.

    {
        $this->_password = $password;

        $this->_soapClient = null;

        return $this;
    }

setHttpsCertificate()

setHttpsCertificate

(

$localCert

)

Set HTTPS client certificate path

Parameters

string

$localCert

local certificate path

Returns

Zend_Soap_Client

Exceptions

Zend_Soap_Client_Exception

with invalid local certificate path argument

Definition at line 723 of file Client.php.

    {
        if (!is_readable($localCert)) {
            #require_once 'Zend/Soap/Client/Exception.php';
            throw new Zend_Soap_Client_Exception('Invalid HTTPS client certificate path.');
        }

        $this->_local_cert = $localCert;

        $this->_soapClient = null;

        return $this;
    }

setHttpsCertPassphrase()

setHttpsCertPassphrase

(

$passphrase

)

Set HTTPS client certificate passphrase

Parameters

string

$passphrase

Returns

Zend_Soap_Client

Definition at line 753 of file Client.php.

    {
        $this->_passphrase = $passphrase;

        $this->_soapClient = null;

        return $this;
    }

setLocation()

setLocation

(

$location

)

Set Location

URI in Web Service the target namespace

Parameters

string

$location

Returns

Zend_Soap_Client

Exceptions

Zend_Soap_Client_Exception

with invalid uri argument

Definition at line 494 of file Client.php.

    {
        $this->validateUrn($location);
        $this->_location = $location;

        $this->_soapClient = null;

        return $this;
    }

setOptions()

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 197 of file Client.php.

    {
        if($options instanceof Zend_Config) {
            $options = $options->toArray();
        }

        foreach ($options as $key => $value) {
            switch ($key) {
                case 'classmap':
                case 'classMap':
                    $this->setClassmap($value);
                    break;
                case 'encoding':
                    $this->setEncoding($value);
                    break;
                case 'soapVersion':
                case 'soap_version':
                    $this->setSoapVersion($value);
                    break;
                case 'wsdl':
                    $this->setWsdl($value);
                    break;
                case 'uri':
                    $this->setUri($value);
                    break;
                case 'location':
                    $this->setLocation($value);
                    break;
                case 'style':
                    $this->setStyle($value);
                    break;
                case 'use':
                    $this->setEncodingMethod($value);
                    break;
                case 'login':
                    $this->setHttpLogin($value);
                    break;
                case 'password':
                    $this->setHttpPassword($value);
                    break;
                case 'proxy_host':
                    $this->setProxyHost($value);
                    break;
                case 'proxy_port':
                    $this->setProxyPort($value);
                    break;
                case 'proxy_login':
                    $this->setProxyLogin($value);
                    break;
                case 'proxy_password':
                    $this->setProxyPassword($value);
                    break;
                case 'local_cert':
                    $this->setHttpsCertificate($value);
                    break;
                case 'passphrase':
                    $this->setHttpsCertPassphrase($value);
                    break;
                case 'compression':
                    $this->setCompressionOptions($value);
                    break;
                case 'stream_context':
                    $this->setStreamContext($value);
                    break;
                case 'features':
                    $this->setSoapFeatures($value);
                    break;
                case 'cache_wsdl':
                    $this->setWsdlCache($value);
                    break;
                case 'useragent':
                case 'userAgent':
                case 'user_agent':
                    $this->setUserAgent($value);
                    break;
                case 'exceptions':
                    $this->setExceptions($value);
                    break;

                // Not used now
                // case 'connection_timeout':
                //     $this->_connection_timeout = $value;
                //    break;

                default:
                    #require_once 'Zend/Soap/Client/Exception.php';
                    throw new Zend_Soap_Client_Exception('Unknown SOAP client option');
                    break;
            }
        }

        return $this;
    }

setProxyHost()

setProxyHost

(

$proxyHost

)

Set proxy host

Parameters

string

$proxyHost

Returns

Zend_Soap_Client

Definition at line 632 of file Client.php.

    {
        $this->_proxy_host = $proxyHost;

        $this->_soapClient = null;

        return $this;
    }

setProxyLogin()

setProxyLogin

(

$proxyLogin

)

Set proxy login

Parameters

string

$proxyLogin

Returns

Zend_Soap_Client

Definition at line 682 of file Client.php.

    {
        $this->_proxy_login = $proxyLogin;

        $this->_soapClient = null;

        return $this;
    }

setProxyPassword()

setProxyPassword

(

$proxyPassword

)

Set proxy password

Parameters

string

$proxyLogin

Returns

Zend_Soap_Client

Definition at line 707 of file Client.php.

    {
        $this->_proxy_password = $proxyPassword;

        $this->_soapClient = null;

        return $this;
    }

setProxyPort()

setProxyPort

(

$proxyPort

)

Set proxy port

Parameters

int

$proxyPort

Returns

Zend_Soap_Client

Definition at line 657 of file Client.php.

    {
        $this->_proxy_port = (int)$proxyPort;

        $this->_soapClient = null;

        return $this;
    }

setSoapClient()

setSoapClient

(

SoapClient

$soapClient

)

Parameters

SoapClient

$soapClient

Returns

Zend_Soap_Client

Definition at line 1214 of file Client.php.

    {
        $this->_soapClient = $soapClient;
        return $this;
    }

setSoapFeatures()

setSoapFeatures

(

$feature

)

Set the SOAP Feature options.

Parameters

string | int

$feature

Returns

Zend_Soap_Client

Definition at line 846 of file Client.php.

    {
        $this->_features = $feature;

        $this->_soapClient = null;
        return $this;
    }

setSoapVersion()

setSoapVersion

(

$version

)

Set SOAP version

Parameters

int

$version

One of the SOAP_1_1 or SOAP_1_2 constants

Returns

Zend_Soap_Client

Exceptions

Zend_Soap_Client_Exception

with invalid soap version argument

Definition at line 350 of file Client.php.

    {
        if (!in_array($version, array(SOAP_1_1, SOAP_1_2))) {
            #require_once 'Zend/Soap/Client/Exception.php';
            throw new Zend_Soap_Client_Exception('Invalid soap version specified. Use SOAP_1_1 or SOAP_1_2 constants.');
        }
        $this->_soapVersion = $version;

        $this->_soapClient = null;

        return $this;
    }

setStreamContext()

setStreamContext

(

$context

)

Set Stream Context

Returns

Zend_Soap_Client

See also

Zend_Soap_Client_Exception

Definition at line 814 of file Client.php.

    {
        if(!is_resource($context) || get_resource_type($context) !== "stream-context") {
            #require_once "Zend/Soap/Client/Exception.php";
            throw new Zend_Soap_Client_Exception(
                "Invalid stream context resource given."
            );
        }

        $this->_stream_context = $context;
        return $this;
    }

setStyle()

setStyle

(

$style

)

Set request style

Parameters

int

$style

One of the SOAP_RPC or SOAP_DOCUMENT constants

Returns

Zend_Soap_Client

Exceptions

Zend_Soap_Client_Exception

with invalid style argument

Definition at line 521 of file Client.php.

    {
        if (!in_array($style, array(SOAP_RPC, SOAP_DOCUMENT))) {
            #require_once 'Zend/Soap/Client/Exception.php';
            throw new Zend_Soap_Client_Exception('Invalid request style specified. Use SOAP_RPC or SOAP_DOCUMENT constants.');
        }

        $this->_style = $style;

        $this->_soapClient = null;

        return $this;
    }

setUri()

setUri

(

$uri

)

Set URI

URI in Web Service the target namespace

Parameters

string

$uri

Returns

Zend_Soap_Client

Exceptions

Zend_Soap_Client_Exception

with invalid uri argument

Definition at line 465 of file Client.php.

    {
        $this->validateUrn($uri);
        $this->_uri = $uri;

        $this->_soapClient = null;

        return $this;
    }

setUserAgent()

setUserAgent

(

$userAgent

)

Set the string to use in User-Agent header

Parameters

string | null

$userAgent

Returns

Zend_Soap_Client

Definition at line 896 of file Client.php.

    {
        if ($userAgent === null) {
            $this->_user_agent = null;
        } else {
            $this->_user_agent = (string)$userAgent;
        }
        return $this;
    }

setWsdl()

setWsdl

(

$wsdl

)

Set wsdl

Parameters

string

$wsdl

Returns

Zend_Soap_Client

Definition at line 170 of file Client.php.

    {
        $this->_wsdl = $wsdl;
        $this->_soapClient = null;

        return $this;
    }

setWsdlCache()

setWsdlCache

(

$caching

)

Set the SOAP Wsdl Caching Options

Parameters

string | int | boolean | null

$caching

Returns

Zend_Soap_Client

Definition at line 870 of file Client.php.

    {
        if ($caching === null) {
            $this->_cache_wsdl = null;
        } else {
            $this->_cache_wsdl = (int)$caching;
        }
        return $this;
    }

validateUrn()

validateUrn

(

$urn

)

Check for valid URN

Parameters

string

$urn

Returns

true

Exceptions

Zend_Soap_Client_Exception

on invalid URN

Definition at line 444 of file Client.php.

    {
        $scheme = parse_url($urn, PHP_URL_SCHEME);
        if ($scheme === false || $scheme === null) {
            #require_once 'Zend/Soap/Client/Exception.php';
            throw new Zend_Soap_Client_Exception('Invalid URN');
        }

        return true;

    }

Field Documentation

$_cache_wsdl

$_cache_wsdl = null

protected

Definition at line 90 of file Client.php.

$_classmap

$_classmap = null

protected

Definition at line 59 of file Client.php.

$_compression

$_compression = null

protected

Definition at line 86 of file Client.php.

$_connection_timeout

$_connection_timeout = null

protected

Definition at line 87 of file Client.php.

$_encoding

$_encoding = 'UTF-8'

protected

Definition at line 53 of file Client.php.

$_exceptions

$_exceptions = null

protected

Definition at line 92 of file Client.php.

$_faultExceptions

$_faultExceptions = array()

protected

Definition at line 65 of file Client.php.

$_features

$_features = null

protected

Definition at line 89 of file Client.php.

$_lastMethod

$_lastMethod = ''

protected

Definition at line 114 of file Client.php.

$_local_cert

$_local_cert = null

protected

Definition at line 84 of file Client.php.

$_location

$_location = null

protected

Definition at line 75 of file Client.php.

$_login

$_login = null

protected

Definition at line 78 of file Client.php.

$_passphrase

$_passphrase = null

protected

Definition at line 85 of file Client.php.

$_password

$_password = null

protected

Definition at line 79 of file Client.php.

$_permanentSoapInputHeaders

$_permanentSoapInputHeaders = array()

protected

Definition at line 132 of file Client.php.

$_proxy_host

$_proxy_host = null

protected

Definition at line 80 of file Client.php.

$_proxy_login

$_proxy_login = null

protected

Definition at line 82 of file Client.php.

$_proxy_password

$_proxy_password = null

protected

Definition at line 83 of file Client.php.

$_proxy_port

$_proxy_port = null

protected

Definition at line 81 of file Client.php.

$_soapClient

$_soapClient

protected

Definition at line 107 of file Client.php.

$_soapInputHeaders

$_soapInputHeaders = array()

protected

Definition at line 123 of file Client.php.

$_soapOutputHeaders

$_soapOutputHeaders = array()

protected

Definition at line 141 of file Client.php.

$_soapVersion

$_soapVersion = SOAP_1_2

protected

Definition at line 71 of file Client.php.

$_stream_context

$_stream_context = null

protected

Definition at line 88 of file Client.php.

$_style

$_style = null

protected

Definition at line 76 of file Client.php.

$_uri

$_uri = null

protected

Set of other SoapClient options

Definition at line 74 of file Client.php.

$_use

$_use = null

protected

Definition at line 77 of file Client.php.

$_user_agent

$_user_agent = null

protected

Definition at line 91 of file Client.php.

$_wsdl

$_wsdl = null

protected

Definition at line 100 of file Client.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Soap/Client.php