"TYPO3 4.0.1: nusoap_base Class Reference", "datetime" => "Sat Dec 2 19:25:17 2006", "date" => "2 Dec 2006", "doxygenversion" => "1.4.6", "projectname" => "TYPO3 4.0.1", "projectnumber" => "4.0.1" ); get_header($doxygen_vars); ?>

nusoap_base Class Reference

Inheritance diagram for nusoap_base:

Inheritance graph
[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)

Public Attributes

 $title = 'NuSOAP'
 $version = '0.7.2'
 $revision = '$Revision: 1421 $'
 $error_str = ''
 $debug_str = ''
 $charencoding = true
 $debugLevel
 $XMLSchemaVersion = 'http://www.w3.org/2001/XMLSchema'
 $soap_defencoding = 'ISO-8859-1'
 $namespaces
 $usedNamespaces = array()
 $typemap
 $xmlEntities

Detailed Description

nusoap_base

Author:
Dietrich Ayala <dietrich@ganx4.com>
Version:
Id
class.nusoap.php 1421 2006-04-10 09:27:15Z mundaun
public

Definition at line 62 of file class.nusoap.php.

Constructor & Destructor Documentation

nusoap_base::nusoap_base (   ) 
 

constructor

public

Definition at line 202 of file class.nusoap.php.

Member Function Documentation

nusoap_base::appendDebug (  $  string  ) 
 

adds debug data to the instance debug string without formatting

Parameters:
string $string debug data public

Definition at line 264 of file class.nusoap.php.

Referenced by debug(), serialize_val(), and soapclient::soapclient().

nusoap_base::clearDebug (   ) 
 

clears the current debug data for this instance

public

Definition at line 277 of file class.nusoap.php.

nusoap_base::contractQname (  $  qname  ) 
 

contracts (changes namespace to prefix) a qualified name

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

Definition at line 671 of file class.nusoap.php.

nusoap_base::debug (  $  string  ) 
 

adds debug data to the instance debug string with formatting

Parameters:
string $string debug data private

Definition at line 252 of file class.nusoap.php.

References appendDebug(), and getmicrotime().

Referenced by soap_transport_http::buildPayload(), soap_transport_http::connect(), soap_transport_http::decodeChunked(), soap_transport_http::getResponse(), XMLSchema::parseFile(), XMLSchema::parseString(), soap_transport_http::send(), soap_transport_http::sendRequest(), serialize_val(), soap_transport_http::setCredentials(), soap_transport_http::setEncoding(), soap_transport_http::setProxy(), soap_transport_http::setSOAPAction(), soap_transport_http::setURL(), soap_parser::soap_parser(), soap_transport_http::soap_transport_http(), soapclient::soapclient(), soap_parser::start_element(), wsdl::wsdl(), and XMLSchema::XMLSchema().

nusoap_base::expandEntities (  $  val  ) 
 

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

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

Definition at line 317 of file class.nusoap.php.

Referenced by serialize_val().

nusoap_base::expandQname (  $  qname  ) 
 

expands (changes prefix to namespace) a qualified name

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

Definition at line 696 of file class.nusoap.php.

Referenced by XMLSchema::schemaStartElement().

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:

Definition at line 659 of file class.nusoap.php.

& nusoap_base::getDebug (   ) 
 

gets the current debug data for this instance

Returns:
debug data public

Definition at line 289 of file class.nusoap.php.

& 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

Definition at line 302 of file class.nusoap.php.

nusoap_base::getDebugLevel (   ) 
 

gets the debug level for this instance

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

Definition at line 232 of file class.nusoap.php.

nusoap_base::getError (   ) 
 

returns error string if present

Returns:
mixed error string or false public

Definition at line 334 of file class.nusoap.php.

nusoap_base::getGlobalDebugLevel (   ) 
 

gets the global debug level, which applies to future instances

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

Definition at line 212 of file class.nusoap.php.

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

Definition at line 721 of file class.nusoap.php.

Referenced by XMLSchema::schemaStartElement(), and soap_parser::start_element().

nusoap_base::getmicrotime (   ) 
 

returns the time in ODBC canonical form with microseconds

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

Definition at line 785 of file class.nusoap.php.

Referenced by debug().

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

Definition at line 753 of file class.nusoap.php.

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

Definition at line 738 of file class.nusoap.php.

Referenced by XMLSchema::schemaStartElement(), and soap_parser::start_element().

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

Definition at line 769 of file class.nusoap.php.

Referenced by XMLSchema::schemaStartElement().

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

Definition at line 358 of file class.nusoap.php.

Referenced by serialize_val().

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

Definition at line 382 of file class.nusoap.php.

References appendDebug(), debug(), expandEntities(), isArraySimpleOrStruct(), and varDump().

Referenced by soapval::serialize(), and soap_fault::serialize().

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

Definition at line 608 of file class.nusoap.php.

nusoap_base::setDebugLevel (  $  level  ) 
 

sets the debug level for this instance

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

Definition at line 242 of file class.nusoap.php.

nusoap_base::setError (  $  str  ) 
 

sets error string

Returns:
boolean $string error string private

Definition at line 347 of file class.nusoap.php.

Referenced by soap_transport_http::connect(), soap_transport_http::getResponse(), XMLSchema::parseFile(), XMLSchema::parseString(), soap_transport_http::send(), soap_transport_http::sendRequest(), soap_parser::soap_parser(), and soapclient::soapclient().

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

Definition at line 222 of file class.nusoap.php.

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

Definition at line 804 of file class.nusoap.php.

Referenced by serialize_val().

Member Data Documentation

nusoap_base::$namespaces
 

Initial value:

 array(
                'SOAP-ENV' => 'http://schemas.xmlsoap.org/soap/envelope/',
                'xsd' => 'http://www.w3.org/2001/XMLSchema',
                'xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
                'SOAP-ENC' => 'http://schemas.xmlsoap.org/soap/encoding/'
                )

Reimplemented in soap_parser.

Definition at line 139 of file class.nusoap.php.

Referenced by XMLSchema::XMLSchema().

nusoap_base::$typemap
 

Initial value:

 array(
        'http://www.w3.org/2001/XMLSchema' => array(
                'string'=>'string','boolean'=>'boolean','float'=>'double','double'=>'double','decimal'=>'double',
                'duration'=>'','dateTime'=>'string','time'=>'string','date'=>'string','gYearMonth'=>'',
                'gYear'=>'','gMonthDay'=>'','gDay'=>'','gMonth'=>'','hexBinary'=>'string','base64Binary'=>'string',
                // abstract "any" types
                'anyType'=>'string','anySimpleType'=>'string',
                // derived datatypes
                'normalizedString'=>'string','token'=>'string','language'=>'','NMTOKEN'=>'','NMTOKENS'=>'','Name'=>'','NCName'=>'','ID'=>'',
                'IDREF'=>'','IDREFS'=>'','ENTITY'=>'','ENTITIES'=>'','integer'=>'integer','nonPositiveInteger'=>'integer',
                'negativeInteger'=>'integer','long'=>'integer','int'=>'integer','short'=>'integer','byte'=>'integer','nonNegativeInteger'=>'integer',
                'unsignedLong'=>'','unsignedInt'=>'','unsignedShort'=>'','unsignedByte'=>'','positiveInteger'=>''),
        'http://www.w3.org/2000/10/XMLSchema' => array(
                'i4'=>'','int'=>'integer','boolean'=>'boolean','string'=>'string','double'=>'double',
                'float'=>'double','dateTime'=>'string',
                'timeInstant'=>'string','base64Binary'=>'string','base64'=>'string','ur-type'=>'array'),
        'http://www.w3.org/1999/XMLSchema' => array(
                'i4'=>'','int'=>'integer','boolean'=>'boolean','string'=>'string','double'=>'double',
                'float'=>'double','dateTime'=>'string',
                'timeInstant'=>'string','base64Binary'=>'string','base64'=>'string','ur-type'=>'array'),
        'http://soapinterop.org/xsd' => array('SOAPStruct'=>'struct'),
        'http://schemas.xmlsoap.org/soap/encoding/' => array('base64'=>'string','array'=>'array','Array'=>'array'),
    'http://xml.apache.org/xml-soap' => array('Map')
        )

Definition at line 161 of file class.nusoap.php.

nusoap_base::$xmlEntities
 

Initial value:

 array('quot' => '"','amp' => '&',
                'lt' => '<','gt' => '>','apos' => "'")

Definition at line 194 of file class.nusoap.php.

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