Inherited Variables
Inherited Constants
Inherited Methods
Class: VObject
- VObject::__construct()
- Class Constructor
- VObject::bind()
- Bind values to this object
- VObject::delete()
- Delete Object
- VObject::get()
- Get value
- VObject::getAll()
- Get all object values
- VObject::getError()
- Get error message
- VObject::getErrors()
- Get errors
- VObject::getMethods()
- Get object methods
- VObject::getProperties()
- Get object properties
- VObject::save()
- Save Object
- VObject::set()
- Set a value
- VObject::setError()
- Set error value
- VObject::setProperties()
- Set property values
- VObject::setProperty()
- Set property value
- VObject::toString()
- Convert object to string
- VObject::__destruct()
- Class Destructor
- VObject::__toString()
- Return object as a string
Class Details
Virtual Web Platform - SOAP Client
This class provides the default SOAP Client.
Note: Currently this system is using the PHP soap extension. There have been instances where server 500 errors are being generated while trying to access data provided by the SoapClient. It appears that these errors can be avoided with the use of static functions and static variables to store a copy of the data returned by the SoapClient. These copies are being created successfuly by sending data from the SoapClient to a static function which populates local variables with empty strings, appends the data provided by the SoapClient to the empty string, and lastly stores the new string in a static variable. As the php SoapClient is unrealiable it appears that a custom soap implementation is needed.
Tags:
- author - Ralph Ritoch <rritoch@gmail.com>
- copyright - (c) Ralph Ritoch - All Rights Reserved
- link - VNetPublishing.Com
- license - VNETLPL Limited Public License
[ Top ]
Class Variables
$_allow_transfer = true
[line 155]
Tags:
- var - Allow transfer
- access - public
Type: boolean
Overrides:
[ Top ]
$_client
[line 85]
Tags:
- var - Soap Transport Object
- access - protected
Type: object
Overrides:
[ Top ]
$_last_location = null
[line 164]
Last Location
Tags:
- var - last endpoint
- access - public
Type: string
Overrides:
[ Top ]
$_last_request = null
[line 114]
Tags:
- var - Last SOAP request XML
- access - protected
Type: string
Overrides:
[ Top ]
$_last_response = null
[line 121]
Tags:
- var - Last SOAP response XML
- access - protected
Type: string
Overrides:
[ Top ]
$_options = array()
[line 99]
Tags:
- var - SOAP options
- access - protected
Type: array
Overrides:
[ Top ]
$_pending_request_headers = null
[line 139]
Request Headers
Tags:
- var - Request headers
- access - protected
Type: mixed
Overrides:
[ Top ]
$_soap_cache_enabled = null
[line 130]
Cache enabled
Tags:
- access - protected
Type: mixed
Overrides:
[ Top ]
$_translator = null
[line 148]
Soap Message Translator
Tags:
- var - Soap Translator
- access - public
Type: object
Overrides:
[ Top ]
$_wsdl = null
[line 92]
Tags:
- var - WSDL Filename
- access - protected
Type: string
Overrides:
[ Top ]
$_wsdl_doc = null
[line 106]
Tags:
- var - WSDL Document
- access - protected
Type: array
Overrides:
[ Top ]
Class Methods
static filterRequest
static string filterRequest(
string
$request, string
$location)
[line 242]
Filter request dispatcher
Note: This function is called after data serialization and before the transport is used to provide applications the ability to create custom serialization features.
Tags:
- return - Fully serialized request
- access - public
Parameters:
- string $request - Soap Request
- string $location - Request endpoint URL
[ Top ]
static filterResponse
static string filterResponse(
string
$response)
[line 275]
Filter response dispatcher
Note: This function is called after the SOAP response is received from the transport layer and before the data is deserialized. This allows applications to implement custom deserialization features. The data returned by this function is sent to the deserializer.
Tags:
- return - Virtual Soap response
- access - public
Parameters:
- string $response -
[ Top ]
__construct
VSoapClient __construct(
)
[line 695]
Class constructor
Tags:
- access - public
Overrides VObject::__construct() (Class Constructor)
Parameters:
[ Top ]
call
mixed call(
string
$method, mixed
$data, [
$debug = false])
[line 428]
Send a SOAP Message
Tags:
- return - Decoded SOAP response on success, error or warning otherwise
Parameters:
- string $method - Method
- mixed $data - Raw SOAP Message
- $debug -
[ Top ]
connect
boolean|object True connect(
[boolean
$localWSDL = true])
[line 520]
Connect to SOAP Transport
Tags:
- return - on success, error or warning otherwise
- access - public
Parameters:
- boolean $localWSDL - use local copy of WSDL file
[ Top ]
disableCache
void disableCache(
)
[line 635]
Disable SOAP cache
Tags:
- access - public
Parameters:
[ Top ]
enableCache
boolean enableCache(
[string
$ttl = 86400])
[line 662]
Enable SOAP cache
Tags:
- return - True on success
- access - public
Parameters:
- string $ttl - Cache file Time To Live in seconds
[ Top ]
ezCall
mixed ezCall(
string
$method, array
$params, string
$targetNS, [
$debug = false])
[line 408]
Send a SOAP message using a translator
Tags:
- return - Decoded SOAP response
- access - public
Parameters:
- string $method - Method
- array $params - List of parameters
- string $targetNS - Target namespace
- $debug -
[ Top ]
getAccessPoint
string getAccessPoint(
[string
$service = null])
[line 389]
Locate the access point URL in WSDL document
Tags:
- return - Access point
- access - public
Parameters:
- string $service - Service to locate
[ Top ]
getBinding
object Node getBinding(
[string
$name = null])
[line 363]
Locate a WSDL Binding Node
Tags:
- return - on success, error or warning otherwise
- access - public
Parameters:
- string $name - Binding QName identifier
[ Top ]
getLastLocation
string getLastLocation(
)
[line 224]
Get last endpoint
Tags:
- return - Last endpoint URL
- access - public
Parameters:
[ Top ]
getLastRequest
string|object XML getLastRequest(
)
[line 495]
Get Last Soap Request Message XML
Tags:
- return - on success, error or warning otherwise
- access - public
Parameters:
[ Top ]
getLastResponse
string|object XML getLastResponse(
)
[line 507]
Get Last Soap Response Message XML
Tags:
- return - on success, error or warning otherwise
- access - public
Parameters:
[ Top ]
getOperation
object Node getOperation(
object
$node, string
$name)
[line 338]
Locate a WSDL Operation Node
Tags:
- return - on success, error or warning otherwise
- access - public
Parameters:
- object $node - Node to search (either a PortType or Binding Node)
- string $name - Method name
[ Top ]
getPortType
object Node getPortType(
string
$name)
[line 307]
Locate a WSDL PortType Node
Tags:
- return - on success, error or warning otherwise
- access - public
Parameters:
- string $name - PortType QName identifier
[ Top ]
getResponseHeaders
mixed getResponseHeaders(
)
[line 610]
Get response headers
Note: Deserialization is done by the Soap translator
Tags:
- return - Unserialized response headers
- access - public
Parameters:
[ Top ]
setAllowTransport
void setAllowTransport(
boolean
$allow)
[line 209]
Set allow transport flag
Tags:
- access - public
Parameters:
- boolean $allow - Allow transport
[ Top ]
setOptions
void setOptions(
array
$opt)
[line 624]
Set Client Options
Tags:
- access - public
Parameters:
- array $opt - Soap Client Options
[ Top ]
setRequestHeaders
void setRequestHeaders(
mixed
$headers)
[line 588]
Set request headers
Note: The headers are sent through the translator to ensure proper serialization
Tags:
- access - public
Parameters:
- mixed $headers - Request headers
[ Top ]
setTranslator
void setTranslator(
object
$translator)
[line 684]
Set Soap Translator
Tags:
- access - public
Parameters:
- object $translator - Soap Translator
[ Top ]
setWSDL
void setWSDL(
string
$wsdl)
[line 574]
Set WSDL Filename
Tags:
- access - public
Parameters:
- string $wsdl - WSDL Filename
[ Top ]