Class PackageNameWsdlClass

Description
Description | Vars (details) | Methods (details) Constants (details)

Implements interfaces:

  • ArrayAccess (internal interface)
  • Iterator (internal interface)
  • Countable (internal interface)

PackageNameWsdlClass to communicate with SOAP service

meta_informations

Located in /WsdlClassFileTpl.php (line 11) 

stdClass
   |
   --PackageNameWsdlClass
Class Constant Summary
Description | Constants (details) Vars (details) | | Methods (details)
VALUE_WSDL_URL = 'wsdl_url_value'
WSDL_AUTHENTICATION = 'wsdl_authentication'
WSDL_CACHE_WSDL = 'wsdl_cache_wsdl'
WSDL_COMPRESSION = 'wsdl_compression'
WSDL_CONNECTION_TIMEOUT = 'wsdl_connection_timeout'
WSDL_ENCODING = 'wsdl_encoding'
WSDL_EXCEPTIONS = 'wsdl_exceptions'
WSDL_EXCPTS = 'wsdl_exceptions'
WSDL_FEATURES = 'wsdl_features'
WSDL_KEEP_ALIVE = 'wsdl_keep_alive'
WSDL_LOCAL_CERT = 'wsdl_local_cert'
WSDL_LOGIN = 'wsdl_login'
WSDL_PASSPHRASE = 'wsdl_passphrase'
WSDL_PASSWD = 'wsdl_password'
WSDL_PASSWORD = 'wsdl_password'
WSDL_PROXY_HOST = 'wsdl_proxy_host'
WSDL_PROXY_LOGIN = 'wsdl_proxy_login'
WSDL_PROXY_PASSWORD = 'wsdl_proxy_password'
WSDL_PROXY_PORT = 'wsdl_proxy_port'
WSDL_SOAP_VERSION = 'wsdl_soap_version'
WSDL_SSL_METHOD = 'wsdl_ssl_method'
WSDL_STREAM_CONTEXT = 'wsdl_stream_context'
WSDL_TRACE = 'wsdl_trace'
WSDL_TYPEMAP = 'wsdl_typemap'
WSDL_URL = 'wsdl_url'
WSDL_USER_AGENT = 'wsdl_user_agent'
Variable Summary
Description | Vars (details) | Methods (details) Constants (details)
static SoapClient $soapClient
array $internArrayToIterate
bool $internArrayToIterateIsArray
int $internArrayToIterateOffset
array $lastError
mixed $result
Method Summary
Description | Constants (details) Vars (details) | Methods (details)
static array convertStringHeadersToArray (string $_headers)
static array getDefaultWsdlOptions ()
static DOMDocument|string|null getFormatedXml (string $_string, [bool $_asDomDocument = false])
static SoapClient getSoapClient ()
static string getSoapClientClassName ()
static SoapClient setSoapClient (SoapClient $_soapClient)
static bool valueIsValid (mixed $_value)
static PackageNameWsdlClass|null __set_state (array $_array, [string $_className = __CLASS__])
PackageNameWsdlClass __construct ([array $_arrayOfValues = array()], [bool $_resetSoapClient = true])
bool add (mixed $_item)
int count ()
mixed current ()
mixed first ()
string getAttributeName ()
array getInternArrayToIterate ()
bool getInternArrayToIterateIsArray ()
int getInternArrayToIterateOffset ()
array getLastError ()
SoapFault|null getLastErrorForMethod (string $_methoName)
DOMDocument|string getLastRequest ([bool $_asDomDocument = false])
null|string|array getLastRequestHeaders ([bool $_asArray = false])
DOMDocument|string getLastResponse ([bool $_asDomDocument = false])
null|string|array getLastResponseHeaders ([bool $_asArray = false])
mixed getResult ()
void initInternArrayToIterate ([array $_array = array()], [bool $_internCall = false])
void initSoapClient (array $_wsdlOptions)
mixed item (int $_index)
int key ()
mixed last ()
int length ()
int next ()
bool offsetExists (int $_offset)
mixed offsetGet (int $_offset)
null offsetSet (mixed $_offset, mixed $_value)
null offsetUnset (mixed $_offset)
int rewind ()
bool saveLastError (string $_methoName, SoapFault $_soapFault)
bool setHttpHeader (string $_headerName, mixed $_headerValue)
array setInternArrayToIterate (array $_internArrayToIterate)
bool setInternArrayToIterateIsArray ([bool $_internArrayToIterateIsArray = false])
int setInternArrayToIterateOffset (int $_internArrayToIterateOffset)
array setLastError (array $_lastError)
void setLocation (string $_location)
mixed setResult (mixed $_result)
bool setSoapHeader (string $_nameSpace, string $_name, mixed $_data, [bool $_mustUnderstand = false], [string $_actor = null])
mixed toSend ()
bool valid ()
mixed _get (string $_name)
bool _set (string $_name, mixed $_value)
string __toString ()
Variables
Description | Vars (details) Constants (details) | Methods (details)
static SoapClient $soapClient (line 149)

Soapclient called to communicate with the actual SOAP Service

  • access: private
array $internArrayToIterate (line 164)

Array that contains values when only one parameter is set when calling __construct method

  • access: private
bool $internArrayToIterateIsArray (line 169)

Bool that tells if array is set or not

  • access: private
int $internArrayToIterateOffset (line 174)

Items index browser

  • access: private
array $lastError (line 159)

Contains last errors

  • access: private
mixed $result (line 154)

Contains Soap call result

  • access: private
Methods
Description | Vars (details) Constants (details) Methods (details)
static convertStringHeadersToArray (line 450)

Returns an associative array between the headers name and their respective values

static array convertStringHeadersToArray (string $_headers)
  • string $_headers
static getDefaultWsdlOptions (line 324)

Method returning all default options values

static array getDefaultWsdlOptions ()
static getFormatedXml (line 430)

Returns a XML string content as a DOMDocument or as a formated XML string

static DOMDocument|string|null getFormatedXml (string $_string, [bool $_asDomDocument = false])
  • string $_string
  • bool $_asDomDocument
static getSoapClient (line 234)

Static method getting current SoapClient

static SoapClient getSoapClient ()
static getSoapClientClassName (line 288)

Returns the SoapClient class name to use to create the instance of the SoapClient.

The SoapClient class is determined based on the package name. If a class is named as {PackageName}SoapClient, then this is the class that will be used. Be sure that this class inherits from the native PHP SoapClient class and this class has been loaded or can be loaded. The goal is to allow the override of the SoapClient without having to modify this generated class. Then the overridding SoapClient class can override for example the SoapClient::__toRequest() method if it is needed.

static string getSoapClientClassName ()
static setSoapClient (line 243)

Static method setting current SoapClient

static SoapClient setSoapClient (SoapClient $_soapClient)
  • SoapClient $_soapClient
static valueIsValid (line 933)

Generic method telling if current value is valid according to the attribute setted with the current value

  • return: true|false
  • access: public
static bool valueIsValid (mixed $_value)
  • mixed $_value: the value to test
static __set_state (line 215)

Generic method called when an object has been exported with var_export() functions

It allows to return an object instantiated with the values

static PackageNameWsdlClass|null __set_state (array $_array, [string $_className = __CLASS__])
  • array $_array: the exported values
  • string $_className: optional (used by inherited classes in order to always call this method)
Constructor __construct (line 185)

Constructor

PackageNameWsdlClass __construct ([array $_arrayOfValues = array()], [bool $_resetSoapClient = true])
  • array $_arrayOfValues: SoapClient options or object attribute values
  • bool $_resetSoapClient: allows to disable the SoapClient redefinition
add (line 665)

Default method adding item to array

bool add (mixed $_item)
  • mixed $_item: value
count (line 591)

Method returning item length, alias to length

int count ()
Implementation of:
Countable::count
current (line 600)

Method returning the current element

mixed current ()
Implementation of:
Iterator::current
first (line 706)

Method returning the first item

mixed first ()
getAttributeName (line 924)

Method returning alone attribute name when class is *array* type

string getAttributeName ()
getInternArrayToIterate (line 817)

Method returning intern array to iterate trough

array getInternArrayToIterate ()
getInternArrayToIterateIsArray (line 877)

Method returning true if intern array is an actual array

bool getInternArrayToIterateIsArray ()
getInternArrayToIterateOffset (line 834)

Method returnint intern array index when iterating trough

int getInternArrayToIterateOffset ()
getLastError (line 781)

Method returning last errors occured during the calls

  • access: public
array getLastError ()
getLastErrorForMethod (line 809)

Method getting the last error for a certain method

  • access: public
SoapFault|null getLastErrorForMethod (string $_methoName)
  • string $_methoName: method name to get error from
getLastRequest (line 369)

Returns the last request content as a DOMDocument or as a formated XML String

DOMDocument|string getLastRequest ([bool $_asDomDocument = false])
  • bool $_asDomDocument
getLastRequestHeaders (line 399)

Returns the last request headers used by the SoapClient object as the original value or an array

null|string|array getLastRequestHeaders ([bool $_asArray = false])
  • bool $_asArray: allows to get the headers in an associative array
getLastResponse (line 384)

Returns the last response content as a DOMDocument or as a formated XML String

DOMDocument|string getLastResponse ([bool $_asDomDocument = false])
  • bool $_asDomDocument
getLastResponseHeaders (line 415)

Returns the last response headers used by the SoapClient object as the original value or an array

null|string|array getLastResponseHeaders ([bool $_asArray = false])
  • bool $_asArray: allows to get the headers in an associative array
getResult (line 764)

Method returning current result from Soap call

  • access: public
mixed getResult ()
initInternArrayToIterate (line 850)

Method initiating internArrayToIterate

void initInternArrayToIterate ([array $_array = array()], [bool $_internCall = false])
  • array $_array: the array to iterate trough
  • bool $_internCall: indicates that methods is calling itself
initSoapClient (line 256)

Method initiating SoapClient

void initSoapClient (array $_wsdlOptions)
  • array $_wsdlOptions: WSDL options
item (line 649)

Method alias to offsetGet

mixed item (int $_index)
  • int $_index
key (line 638)

Method returning current itemOffset value, alias to getInternArrayToIterateOffset

int key ()
Implementation of:
Iterator::key
last (line 716)

Method returning the last item

mixed last ()
length (line 581)

Method alias to count

int length ()
next (line 610)

Method moving the current position to the next element

int next ()
Implementation of:
Iterator::next
offsetExists (line 727)

Method testing index in item

bool offsetExists (int $_offset)
  • int $_offset
Implementation of:
ArrayAccess::offsetExists
offsetGet (line 737)

Method returning the item at "index" value

mixed offsetGet (int $_offset)
  • int $_offset
Implementation of:
ArrayAccess::offsetGet
offsetSet (line 747)

Method useless but necessarly overridden, can't set

  • access: public
null offsetSet (mixed $_offset, mixed $_value)
  • mixed $_offset
  • mixed $_value
Implementation of:
ArrayAccess::offsetSet
offsetUnset (line 756)

Method useless but necessarly overridden, can't unset

  • access: public
null offsetUnset (mixed $_offset)
  • mixed $_offset
Implementation of:
ArrayAccess::offsetUnset
rewind (line 619)

Method resetting itemOffset

int rewind ()
Implementation of:
Iterator::rewind
saveLastError (line 800)

Method saving the last error returned by the SoapClient

  • return: true|false
  • access: protected
bool saveLastError (string $_methoName, SoapFault $_soapFault)
  • string $_methoName: the method called when the error occurred
  • SoapFault $_soapFault: l'objet de l'erreur
setHttpHeader (line 508)

Sets the SoapClient Stream context HTTP Header name according to its value

If a context already exists, it tries to modify it It the context does not exist, it then creates it with the header name and its value

bool setHttpHeader (string $_headerName, mixed $_headerValue)
  • string $_headerName
  • mixed $_headerValue
setInternArrayToIterate (line 826)

Method setting intern array to iterate trough

array setInternArrayToIterate (array $_internArrayToIterate)
  • array $_internArrayToIterate
setInternArrayToIterateIsArray (line 886)

Method setting if intern array is an actual array

bool setInternArrayToIterateIsArray ([bool $_internArrayToIterateIsArray = false])
  • bool $_internArrayToIterateIsArray
setInternArrayToIterateOffset (line 869)

Method setting intern array offset when iterating trough

int setInternArrayToIterateOffset (int $_internArrayToIterateOffset)
  • int $_internArrayToIterateOffset
setLastError (line 790)

Method setting last errors occured during the calls

array setLastError (array $_lastError)
  • array $_lastError
setLocation (line 356)

Allows to set the SoapClient location to call

void setLocation (string $_location)
  • string $_location
setResult (line 773)

Method setting current result from Soap call

  • access: protected
mixed setResult (mixed $_result)
  • mixed $_result
setSoapHeader (line 476)

Sets a SoapHeader to send

For more information, please read the online documentation on http://www.php.net/manual/en/class.soapheader.php

bool setSoapHeader (string $_nameSpace, string $_name, mixed $_data, [bool $_mustUnderstand = false], [string $_actor = null])
  • string $_nameSpace: SoapHeader namespace
  • string $_name: SoapHeader name
  • mixed $_data: SoapHeader data
  • bool $_mustUnderstand
  • string $_actor
toSend (line 694)

Method to call when sending data to request for *array* type class

mixed toSend ()
valid (line 629)

Method checking if current itemOffset points to an existing item

bool valid ()
Implementation of:
Iterator::valid
_get (line 912)

Generic method getting value

mixed _get (string $_name)
  • string $_name: property name to get
_set (line 896)

Generic method setting value

bool _set (string $_name, mixed $_value)
  • string $_name: property name to set
  • mixed $_value: property value to use
__toString (line 941)

Method returning actual class name

string __toString ()
Class Constants
Description | Constants (details) Vars (details) | Methods (details)
VALUE_WSDL_URL = 'wsdl_url_value' (line 22)

Constant to define the default WSDL URI

WSDL_AUTHENTICATION = 'wsdl_authentication' (line 139)

Option key to define WSDL authentication

WSDL_CACHE_WSDL = 'wsdl_cache_wsdl' (line 59)

Option key to define WSDL cache_wsdl

WSDL_COMPRESSION = 'wsdl_compression' (line 74)

Option key to define WSDL compression

WSDL_CONNECTION_TIMEOUT = 'wsdl_connection_timeout' (line 84)

Option key to define WSDL connection_timeout

WSDL_ENCODING = 'wsdl_encoding' (line 79)

Option key to define WSDL encoding

WSDL_EXCEPTIONS = 'wsdl_exceptions' (line 54)

Option key to define WSDL exceptions

WSDL_EXCPTS = 'wsdl_exceptions' (line 49)

Option key to define WSDL exceptions

  • deprecated: use WSDL_EXCEPTIONS instead
WSDL_FEATURES = 'wsdl_features' (line 99)

Option key to define WSDL features

WSDL_KEEP_ALIVE = 'wsdl_keep_alive' (line 104)

Option key to define WSDL keep_alive

WSDL_LOCAL_CERT = 'wsdl_local_cert' (line 129)

Option key to define WSDL local_cert

WSDL_LOGIN = 'wsdl_login' (line 27)

Option key to define WSDL login

WSDL_PASSPHRASE = 'wsdl_passphrase' (line 134)

Option key to define WSDL passphrase

WSDL_PASSWD = 'wsdl_password' (line 33)

Option key to define WSDL password

  • deprecated: use WSDL_PASSWORD instead
WSDL_PASSWORD = 'wsdl_password' (line 38)

Option key to define WSDL password

WSDL_PROXY_HOST = 'wsdl_proxy_host' (line 109)

Option key to define WSDL proxy_host

WSDL_PROXY_LOGIN = 'wsdl_proxy_login' (line 119)

Option key to define WSDL proxy_login

WSDL_PROXY_PASSWORD = 'wsdl_proxy_password' (line 124)

Option key to define WSDL proxy_password

WSDL_PROXY_PORT = 'wsdl_proxy_port' (line 114)

Option key to define WSDL proxy_port

WSDL_SOAP_VERSION = 'wsdl_soap_version' (line 69)

Option key to define WSDL soap_version

WSDL_SSL_METHOD = 'wsdl_ssl_method' (line 144)

Option key to define WSDL ssl_method

WSDL_STREAM_CONTEXT = 'wsdl_stream_context' (line 64)

Option key to define WSDL stream_context

WSDL_TRACE = 'wsdl_trace' (line 43)

Option key to define WSDL trace option

WSDL_TYPEMAP = 'wsdl_typemap' (line 89)

Option key to define WSDL typemap

WSDL_URL = 'wsdl_url' (line 17)

Option key to define WSDL url

WSDL_USER_AGENT = 'wsdl_user_agent' (line 94)

Option key to define WSDL user_agent

Documentation generated on Thu, 20 Feb 2014 22:48:27 +0100 by phpDocumentor 1.4.4