Class: nusoap_base

Source Location: /modules/nusoap/class.nusoap_base.php

Class Overview

nusoap_base

Author(s):

Scott Nichol <snichol@users.sourceforge.net>
Dietrich Ayala <dietrich@ganx4.com>

Version:

$Id$

Variables

Methods

Class Details

[line 86]
nusoap_base

Tags:

author:	Scott Nichol <snichol@users.sourceforge.net>
author:	Dietrich Ayala <dietrich@ganx4.com>
version:	$Id$
access:	public

[ Top ]

Class Variables

$namespaces = 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/'
      )

[line 163]

namespaces in an array of prefix => uri

this is "seeded" by a set of constants, but it may be altered by code

Tags:

access:

public

Type:

array

[ Top ]

$soap_defencoding = 'ISO-8859-1'

[line 152]

charset encoding for outgoing messages

Tags:

access:

public

Type:

string

[ Top ]

$typemap = 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'))

[line 185]

XML Schema types in an array of uri => (array of xml type => php type) is this legacy yet? no, this is used by the nusoap_xmlschema class to verify type => namespace mappings.

Tags:

access:

public

Type:

array

[ Top ]

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

[line 218]

XML entities to convert

Tags:

see:	expandEntities
deprecated:
access:	public

Type:

array

[ Top ]

$XMLSchemaVersion = 'http://www.w3.org/2001/XMLSchema'

[line 144]

set schema version

Tags:

access:

public

Type:

string

[ Top ]

Class Methods

constructor nusoap_base [line 226]

nusoap_base nusoap_base(
)

constructor

Tags:

access:

public

[ Top ]

method appendDebug [line 288]

void appendDebug(
string
$string)

adds debug data to the instance debug string without formatting

Tags:

access:

public

Parameters:

string

$string

debug data

[ Top ]

method clearDebug [line 301]

void clearDebug(
)

clears the current debug data for this instance

Tags:

access:

public

[ Top ]

method formatDump [line 729]

string formatDump(
string
$str)

formats a string to be inserted into an HTML stream

Tags:

return:	The formatted string
deprecated:
access:	public

Parameters:

string

$str

The string to format

[ Top ]

method getDebug [line 313]

debug &getDebug(
)

gets the current debug data for this instance

Tags:

return:	data
access:	public

[ Top ]

method getDebugAsXMLComment [line 326]

debug &getDebugAsXMLComment(
)

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

Tags:

return:	data as an XML comment
access:	public

[ Top ]

method getDebugLevel [line 256]

int getDebugLevel(
)

gets the debug level for this instance

Tags:

return:	Debug level 0-9, where 0 turns off
access:	public

[ Top ]

method getError [line 359]

mixed getError(
)

returns error string if present

Tags:

return:	error string or false
access:	public

[ Top ]

method getGlobalDebugLevel [line 236]

integer getGlobalDebugLevel(
)

gets the global debug level, which applies to future instances

Tags:

return:	Debug level 0-9, where 0 turns off
access:	public

[ Top ]

method getLocalPart [line 791]

string getLocalPart(
string
$str)

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

Tags:

return:	The local part
access:	public

Parameters:

string

$str

The prefixed string

[ Top ]

method getmicrotime [line 855]

string getmicrotime(
)

returns the time in ODBC canonical form with microseconds

Tags:

return:	The time in ODBC canonical form with microseconds
access:	public

[ Top ]

method getNamespaceFromPrefix [line 823]

mixed getNamespaceFromPrefix(
string
$prefix)

pass it a prefix, it returns a namespace

Tags:

return:	The namespace, false if no namespace has the specified prefix
access:	public

Parameters:

string

$prefix

The prefix

[ Top ]

method getPrefix [line 808]

mixed getPrefix(
string
$str)

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

Tags:

return:	The prefix or false if there is no prefix
access:	public

Parameters:

string

$str

The prefixed string

[ Top ]

method getPrefixFromNamespace [line 839]

mixed getPrefixFromNamespace(
string
$ns)

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

Tags:

return:	The prefix, false if the namespace has no prefixes
access:	public

Parameters:

string

$ns

The namespace

[ Top ]

method serializeEnvelope [line 674]

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

serializes a message

Tags:

return:	the message
access:	public

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, or associative array
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)

[ Top ]

method serialize_val [line 408]

string serialize_val(
mixed
$val, [string
$name = false], [string
$type = false], [string
$name_ns = false], [string
$type_ns = false], [array
$attributes = false], [string
$use = 'encoded'], [boolean
$soapval = false])

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

Tags:

return:	The serialized element, possibly with child elements
access:	public

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)
boolean	$soapval	Whether this is called from soapval.

[ Top ]

method setDebugLevel [line 266]

void setDebugLevel(
int
$level)

sets the debug level for this instance

Tags:

access:

public

Parameters:

int

$level

Debug level 0-9, where 0 turns off

[ Top ]

method setGlobalDebugLevel [line 246]

void setGlobalDebugLevel(
int
$level)

sets the global debug level, which applies to future instances

Tags:

access:

public

Parameters:

int

$level

Debug level 0-9, where 0 turns off

[ Top ]

method varDump [line 874]

string varDump(
mixed
$data)

Returns a string with the output of var_dump

Tags:

return:	The output of var_dump
access:	public

Parameters:

mixed

$data

The variable to var_dump

[ Top ]

method __toString [line 888]

string __toString(
)

represents the object as a string

Tags:

access:

public

[ Top ]

Documentation generated on Thu, 12 Feb 2009 07:59:53 +0900 by phpDocumentor 1.4.2

Class: nusoap_base

Class Overview

Author(s):

Version:

Variables

Methods

Class Details

Tags:

Class Variables

$namespaces = 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/' )

Tags:

$soap_defencoding = 'ISO-8859-1'

Tags:

Tags:

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

Tags:

$XMLSchemaVersion = 'http://www.w3.org/2001/XMLSchema'

Tags:

Class Methods

constructor nusoap_base [line 226]

Tags:

method appendDebug [line 288]

Tags:

Parameters:

method clearDebug [line 301]

Tags:

method formatDump [line 729]

Tags:

Parameters:

method getDebug [line 313]

Tags:

method getDebugAsXMLComment [line 326]

Tags:

method getDebugLevel [line 256]

Tags:

method getError [line 359]

Tags:

method getGlobalDebugLevel [line 236]

Tags:

method getLocalPart [line 791]

Tags:

Parameters:

method getmicrotime [line 855]

Tags:

method getNamespaceFromPrefix [line 823]

Tags:

Parameters:

method getPrefix [line 808]

Tags:

Parameters:

method getPrefixFromNamespace [line 839]

Tags:

Parameters:

method serializeEnvelope [line 674]

Tags:

Parameters:

method serialize_val [line 408]

Tags:

Parameters:

method setDebugLevel [line 266]

Tags:

Parameters:

method setGlobalDebugLevel [line 246]

Tags:

Parameters:

method varDump [line 874]

Tags:

Parameters:

method __toString [line 888]

Tags:

$namespaces = 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/'
)

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