nusoap_base Class Reference

Inherited by soap_client, soap_client, soap_fault, soap_fault, soap_parser, soap_parser, soap_server, soap_server, soap_transport_http, soap_transport_http, soapval, soapval, wsdl, wsdl, XMLSchema, and XMLSchema.

Inheritance diagram for nusoap_base:

[legend]
List of all members.

Public Member Functions

 nusoap_base ()
 getGlobalDebugLevel ()
 setGlobalDebugLevel ($level)
 getDebugLevel ()
 setDebugLevel ($level)
 debug ($string)
 appendDebug ($string)
 clearDebug ()
getDebug ()
getDebugAsXMLComment ()
 expandEntities ($val)
 getError ()
 setError ($str)
 isArraySimpleOrStruct ($val)
 serialize_val ($val, $name=false, $type=false, $name_ns=false, $type_ns=false, $attributes=false, $use='encoded')
 serializeEnvelope ($body, $headers=false, $namespaces=array(), $style='rpc', $use='encoded', $encodingStyle='http://schemas.xmlsoap.org/soap/encoding/')
 formatDump ($str)
 contractQname ($qname)
 expandQname ($qname)
 getLocalPart ($str)
 getPrefix ($str)
 getNamespaceFromPrefix ($prefix)
 getPrefixFromNamespace ($ns)
 getmicrotime ()
 varDump ($data)
 nusoap_base ()
 getGlobalDebugLevel ()
 setGlobalDebugLevel ($level)
 getDebugLevel ()
 setDebugLevel ($level)
 debug ($string)
 appendDebug ($string)
 clearDebug ()
getDebug ()
getDebugAsXMLComment ()
 expandEntities ($val)
 getError ()
 setError ($str)
 isArraySimpleOrStruct ($val)
 serialize_val ($val, $name=false, $type=false, $name_ns=false, $type_ns=false, $attributes=false, $use='encoded')
 serializeEnvelope ($body, $headers=false, $namespaces=array(), $style='rpc', $use='encoded', $encodingStyle='http://schemas.xmlsoap.org/soap/encoding/')
 formatDump ($str)
 contractQname ($qname)
 expandQname ($qname)
 getLocalPart ($str)
 getPrefix ($str)
 getNamespaceFromPrefix ($prefix)
 getPrefixFromNamespace ($ns)
 getmicrotime ()
 varDump ($data)

Detailed Description

nusoap_base

Author:
Dietrich Ayala <dietrich@ganx4.com>
Version:
$Id$ public


Member Function Documentation

nusoap_base::nusoap_base (  ) 

constructor

public

nusoap_base::getGlobalDebugLevel (  ) 

gets the global debug level, which applies to future instances

Returns:
integer Debug level 0-9, where 0 turns off public

nusoap_base::setGlobalDebugLevel ( level  ) 

sets the global debug level, which applies to future instances

Parameters:
int $level Debug level 0-9, where 0 turns off public

nusoap_base::getDebugLevel (  ) 

gets the debug level for this instance

Returns:
int Debug level 0-9, where 0 turns off public

nusoap_base::setDebugLevel ( level  ) 

sets the debug level for this instance

Parameters:
int $level Debug level 0-9, where 0 turns off public

nusoap_base::debug ( string  ) 

adds debug data to the instance debug string with formatting

Parameters:
string $string debug data private

nusoap_base::appendDebug ( string  ) 

adds debug data to the instance debug string without formatting

Parameters:
string $string debug data public

nusoap_base::clearDebug (  ) 

clears the current debug data for this instance

public

& nusoap_base::getDebug (  ) 

gets the current debug data for this instance

Returns:
debug data public

& nusoap_base::getDebugAsXMLComment (  ) 

gets the current debug data for this instance as an XML comment this may change the contents of the debug data

Returns:
debug data as an XML comment public

nusoap_base::expandEntities ( val  ) 

expands entities, e.g. changes '<' to '<'.

Parameters:
string $val The string in which to expand entities. private

nusoap_base::getError (  ) 

returns error string if present

Returns:
mixed error string or false public

nusoap_base::setError ( str  ) 

sets error string

Returns:
boolean $string error string private

nusoap_base::isArraySimpleOrStruct ( val  ) 

detect if array is a simple array or a struct (associative array)

Parameters:
mixed $val The PHP array
Returns:
string (arraySimple|arrayStruct) private

nusoap_base::serialize_val ( val,
name = false,
type = false,
name_ns = false,
type_ns = false,
attributes = false,
use = 'encoded' 
)

serializes PHP values in accordance w/ section 5. Type information is not serialized if $use == 'literal'.

Parameters:
mixed $val The value to serialize
string $name The name (local part) of the XML element
string $type The XML schema type (local part) for the element
string $name_ns The namespace for the name of the XML element
string $type_ns The namespace for the type of the element
array $attributes The attributes to serialize as name=>value pairs
string $use The WSDL "use" (encoded|literal)
Returns:
string The serialized element, possibly with child elements public

nusoap_base::serializeEnvelope ( body,
headers = false,
namespaces = array(),
style = 'rpc',
use = 'encoded',
encodingStyle = 'http://schemas.xmlsoap.org/soap/encoding/' 
)

serializes a message

Parameters:
string $body the XML of the SOAP body
mixed $headers optional string of XML with SOAP header content, or array of soapval objects for SOAP headers
array $namespaces optional the namespaces used in generating the body and headers
string $style optional (rpc|document)
string $use optional (encoded|literal)
string $encodingStyle optional (usually 'http://schemas.xmlsoap.org/soap/encoding/' for encoded)
Returns:
string the message public

nusoap_base::formatDump ( str  ) 

formats a string to be inserted into an HTML stream

Parameters:
string $str The string to format
Returns:
string The formatted string public
Deprecated:

nusoap_base::contractQname ( qname  ) 

contracts (changes namespace to prefix) a qualified name

Parameters:
string $qname qname
Returns:
string contracted qname private

nusoap_base::expandQname ( qname  ) 

expands (changes prefix to namespace) a qualified name

Parameters:
string $string qname
Returns:
string expanded qname private

nusoap_base::getLocalPart ( str  ) 

returns the local part of a prefixed string returns the original string, if not prefixed

Parameters:
string $str The prefixed string
Returns:
string The local part public

nusoap_base::getPrefix ( str  ) 

returns the prefix part of a prefixed string returns false, if not prefixed

Parameters:
string $str The prefixed string
Returns:
mixed The prefix or false if there is no prefix public

nusoap_base::getNamespaceFromPrefix ( prefix  ) 

pass it a prefix, it returns a namespace

Parameters:
string $prefix The prefix
Returns:
mixed The namespace, false if no namespace has the specified prefix public

nusoap_base::getPrefixFromNamespace ( ns  ) 

returns the prefix for a given namespace (or prefix) or false if no prefixes registered for the given namespace

Parameters:
string $ns The namespace
Returns:
mixed The prefix, false if the namespace has no prefixes public

nusoap_base::getmicrotime (  ) 

returns the time in ODBC canonical form with microseconds

Returns:
string The time in ODBC canonical form with microseconds public

nusoap_base::varDump ( data  ) 

Returns a string with the output of var_dump

Parameters:
mixed $data The variable to var_dump
Returns:
string The output of var_dump public

nusoap_base::nusoap_base (  ) 

constructor

public

nusoap_base::getGlobalDebugLevel (  ) 

gets the global debug level, which applies to future instances

Returns:
integer Debug level 0-9, where 0 turns off public

nusoap_base::setGlobalDebugLevel ( level  ) 

sets the global debug level, which applies to future instances

Parameters:
int $level Debug level 0-9, where 0 turns off public

nusoap_base::getDebugLevel (  ) 

gets the debug level for this instance

Returns:
int Debug level 0-9, where 0 turns off public

nusoap_base::setDebugLevel ( level  ) 

sets the debug level for this instance

Parameters:
int $level Debug level 0-9, where 0 turns off public

nusoap_base::debug ( string  ) 

adds debug data to the instance debug string with formatting

Parameters:
string $string debug data private

nusoap_base::appendDebug ( string  ) 

adds debug data to the instance debug string without formatting

Parameters:
string $string debug data public

nusoap_base::clearDebug (  ) 

clears the current debug data for this instance

public

& nusoap_base::getDebug (  ) 

gets the current debug data for this instance

Returns:
debug data public

& nusoap_base::getDebugAsXMLComment (  ) 

gets the current debug data for this instance as an XML comment this may change the contents of the debug data

Returns:
debug data as an XML comment public

nusoap_base::expandEntities ( val  ) 

expands entities, e.g. changes '<' to '<'.

Parameters:
string $val The string in which to expand entities. private

nusoap_base::getError (  ) 

returns error string if present

Returns:
mixed error string or false public

nusoap_base::setError ( str  ) 

sets error string

Returns:
boolean $string error string private

nusoap_base::isArraySimpleOrStruct ( val  ) 

detect if array is a simple array or a struct (associative array)

Parameters:
mixed $val The PHP array
Returns:
string (arraySimple|arrayStruct) private

nusoap_base::serialize_val ( val,
name = false,
type = false,
name_ns = false,
type_ns = false,
attributes = false,
use = 'encoded' 
)

serializes PHP values in accordance w/ section 5. Type information is not serialized if $use == 'literal'.

Parameters:
mixed $val The value to serialize
string $name The name (local part) of the XML element
string $type The XML schema type (local part) for the element
string $name_ns The namespace for the name of the XML element
string $type_ns The namespace for the type of the element
array $attributes The attributes to serialize as name=>value pairs
string $use The WSDL "use" (encoded|literal)
Returns:
string The serialized element, possibly with child elements public

nusoap_base::serializeEnvelope ( body,
headers = false,
namespaces = array(),
style = 'rpc',
use = 'encoded',
encodingStyle = 'http://schemas.xmlsoap.org/soap/encoding/' 
)

serializes a message

Parameters:
string $body the XML of the SOAP body
mixed $headers optional string of XML with SOAP header content, or array of soapval objects for SOAP headers
array $namespaces optional the namespaces used in generating the body and headers
string $style optional (rpc|document)
string $use optional (encoded|literal)
string $encodingStyle optional (usually 'http://schemas.xmlsoap.org/soap/encoding/' for encoded)
Returns:
string the message public

nusoap_base::formatDump ( str  ) 

formats a string to be inserted into an HTML stream

Parameters:
string $str The string to format
Returns:
string The formatted string public
Deprecated:

nusoap_base::contractQname ( qname  ) 

contracts (changes namespace to prefix) a qualified name

Parameters:
string $qname qname
Returns:
string contracted qname private

nusoap_base::expandQname ( qname  ) 

expands (changes prefix to namespace) a qualified name

Parameters:
string $string qname
Returns:
string expanded qname private

nusoap_base::getLocalPart ( str  ) 

returns the local part of a prefixed string returns the original string, if not prefixed

Parameters:
string $str The prefixed string
Returns:
string The local part public

nusoap_base::getPrefix ( str  ) 

returns the prefix part of a prefixed string returns false, if not prefixed

Parameters:
string $str The prefixed string
Returns:
mixed The prefix or false if there is no prefix public

nusoap_base::getNamespaceFromPrefix ( prefix  ) 

pass it a prefix, it returns a namespace

Parameters:
string $prefix The prefix
Returns:
mixed The namespace, false if no namespace has the specified prefix public

nusoap_base::getPrefixFromNamespace ( ns  ) 

returns the prefix for a given namespace (or prefix) or false if no prefixes registered for the given namespace

Parameters:
string $ns The namespace
Returns:
mixed The prefix, false if the namespace has no prefixes public

nusoap_base::getmicrotime (  ) 

returns the time in ODBC canonical form with microseconds

Returns:
string The time in ODBC canonical form with microseconds public

nusoap_base::varDump ( data  ) 

Returns a string with the output of var_dump

Parameters:
mixed $data The variable to var_dump
Returns:
string The output of var_dump public


The documentation for this class was generated from the following files:
Generated on Thu Nov 2 00:27:14 2006 for XOOPS Cube Legacy by  doxygen 1.5.1