Class: nusoap_base

Source Location: /lodel/scripts/nusoap.php

Class nusoap_base

Class Overview

nusoap_base

Located in /lodel/scripts/nusoap.php [line 63]

Author(s):

Dietrich Ayala <dietrich@ganx4.com>

API Tags:

Access:

public

Information Tags:

Version:

$Id: nusoap.php 3705 2006-09-14 16:06:29Z cenou $

Properties

Methods

[ Top ]

Descendants

Child Class	Description
soap_fault	soap_fault class, allows for creation of faults mainly used for returning faults from deployed functions in a server instance.
XMLSchema	parses an XML Schema, allows access to it's data, other utility methods no validation... yet.
soapval	for creating serializable abstractions of native PHP types NOTE: this is only really used when WSDL is not available.
soap_transport_http	transport class for sending/receiving data via HTTP and HTTPS NOTE: PHP must be compiled with the CURL extension for HTTPS support
soap_server	soap_server allows the user to create a SOAP server that is capable of receiving messages and returning responses
wsdl	parses a WSDL file, allows access to it's data, other utility methods
soap_parser	soap_parser class parses SOAP XML messages into native PHP values
mysoapclient	soapclient higher level class for easy usage.

[ Top ]

Property Summary

mixed	$charencoding
mixed	$debug_str
mixed	$error_str
namespaces	$namespaces	load namespace uris into an array of uri => prefix
mixed	$revision
soap_defencoding	$soap_defencoding	set charset encoding for outgoing messages
mixed	$title
typemap	$typemap	load types into typemap array is this legacy yet? no, this is used by the xmlschema class to verify type => namespace mappings.
mixed	$usedNamespaces
mixed	$version
xmlEntities	$xmlEntities	entities to convert
XMLSchemaVersion	$XMLSchemaVersion	set schema version

[ Top ]

Method Summary

void	appendDebug()	adds debug data to the instance debug string without formatting
void	clearDebug()	clears the current debug data for this instance
string	contractQname()	contracts a qualified name
void	debug()	adds debug data to the instance debug string with formatting
void	expandEntities()	expands entities, e.g. changes '<' to '<'.
string	expandQname()	expands a qualified name
void	formatDump()
debug	&getDebug()	gets the current debug data for this instance
debug	&getDebugAsXMLComment()	gets the current debug data for this instance as an XML comment this may change the contents of the debug data
mixed	getError()	returns error string if present
string	getLocalPart()	returns the local part of a prefixed string returns the original string, if not prefixed
string	getmicrotime()	returns the time in ODBC canonical form with microseconds
mixed	getNamespaceFromPrefix()	pass it a prefix, it returns a namespace returns false if no namespace registered with the given prefix
mixed	getPrefix()	returns the prefix part of a prefixed string returns false, if not prefixed
mixed	getPrefixFromNamespace()	returns the prefix for a given namespace (or prefix) or false if no prefixes registered for the given namespace
string	isArraySimpleOrStruct()	detect if array is a simple array or a struct (associative array)
string	serializeEnvelope()	serialize message
string	serialize_val()	serializes PHP values in accordance w/ section 5. Type information is not serialized if $use == 'literal'.
boolean	setError()	sets error string
void	varDump()

[ Top ]

Properties

mixed $charencoding = true [line 72]

[ Top ]

mixed $debug_str = '' [line 69]

[ Top ]

mixed $error_str = '' [line 68]

[ Top ]

namespaces $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/',
'si' => 'http://soapinterop.org/xsd') [line 97]

load namespace uris into an array of uri => prefix

API Tags:

Access:

public

Redefined in descendants as:

soap_parser::$namespaces

[ Top ]

mixed $revision = '$Revision: 3705 $' [line 67]

[ Top ]

soap_defencoding $soap_defencoding = 'ISO-8859-1' [line 89]

set charset encoding for outgoing messages

API Tags:

Access:

public

[ Top ]

mixed $title = 'NuSOAP' [line 65]

[ Top ]

typemap $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/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 112]

load types into typemap array is this legacy yet? no, this is used by the xmlschema class to verify type => namespace mappings.

API Tags:

Access:

public

[ Top ]

mixed $usedNamespaces = array() [line 103]

[ Top ]

mixed $version = '0.6.8' [line 66]

[ Top ]

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

entities to convert

API Tags:

Access:

public

[ Top ]

XMLSchemaVersion $XMLSchemaVersion = 'http://www.w3.org/2001/XMLSchema' [line 80]

set schema version

API Tags:

Access:

public

[ Top ]

Methods

appendDebug [line 158]

void appendDebug(
string
$string 
)

adds debug data to the instance debug string without formatting

Parameters:

string

$string:

debug data

API Tags:

Access:

private

[ Top ]

clearDebug [line 169]

void clearDebug(
)

clears the current debug data for this instance

API Tags:

Access:

public

[ Top ]

contractQname [line 515]

string contractQname(

$qname, string
$string 
)

contracts a qualified name

Parameters:

string	$string:	qname
	$qname:

API Tags:

Return:	contracted qname
Access:	private

[ Top ]

debug [line 148]

void debug(
string
$string 
)

adds debug data to the instance debug string with formatting

Parameters:

string

$string:

debug data

API Tags:

Access:

private

[ Top ]

expandEntities [line 209]

void expandEntities(
string
$val 
)

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

Parameters:

string

$val:

The string in which to expand entities.

API Tags:

Access:

private

[ Top ]

expandQname [line 540]

string expandQname(

$qname, string
$string 
)

expands a qualified name

Parameters:

string	$string:	qname
	$qname:

API Tags:

Return:	expanded qname
Access:	private

[ Top ]

formatDump [line 503]

void formatDump(

$str 
)

Parameters:

$str:

[ Top ]

getDebug [line 181]

debug &getDebug(
)

gets the current debug data for this instance

API Tags:

Return:	data
Access:	public

[ Top ]

getDebugAsXMLComment [line 194]

debug &getDebugAsXMLComment(
)

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

API Tags:

Return:	data as an XML comment
Access:	public

[ Top ]

getError [line 226]

mixed getError(
)

returns error string if present

API Tags:

Return:	error string or false
Access:	public

[ Top ]

getLocalPart [line 565]

string getLocalPart(
string
$str 
)

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

Parameters:

string

$str:

API Tags:

Access:

public

[ Top ]

getmicrotime [line 630]

string getmicrotime(
)

returns the time in ODBC canonical form with microseconds

API Tags:

Access:

public

[ Top ]

getNamespaceFromPrefix [line 598]

mixed getNamespaceFromPrefix(
string
$prefix 
)

pass it a prefix, it returns a namespace returns false if no namespace registered with the given prefix

Parameters:

string

$prefix:

API Tags:

Access:

public

[ Top ]

getPrefix [line 582]

mixed getPrefix(
string
$str 
)

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

Parameters:

string

$str:

API Tags:

Access:

public

[ Top ]

getPrefixFromNamespace [line 614]

mixed getPrefixFromNamespace(
string
$ns 
)

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

Parameters:

string

$ns:

API Tags:

Access:

public

[ Top ]

isArraySimpleOrStruct [line 250]

string isArraySimpleOrStruct(
$val
$val 
)

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

Parameters:

$val

$val:

The PHP array

API Tags:

Return:	(arraySimple\|arrayStruct)
Access:	private

[ Top ]

serializeEnvelope [line 474]

string serializeEnvelope(
string
$body, [string
$headers = false], [array
$namespaces = array()], [string
$style = 'rpc'], [string
$use = 'encoded'] 
)

serialize message

Parameters:

string	$body:	body
string	$headers:	headers optional
array	$namespaces:	namespaces optional
string	$style:	style optional (rpc\|document)
string	$use:	use optional (encoded\|literal)

API Tags:

Return:	message
Access:	public

[ Top ]

serialize_val [line 267]

string 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:

	$val:
	$name:
	$type:
	$name_ns:
	$type_ns:
	$attributes:
	$use:

API Tags:

Access:

public

[ Top ]

setError [line 239]

boolean setError(

$str 
)

sets error string

Parameters:

$str:

API Tags:

Return:	error string
Access:	private

[ Top ]

varDump [line 642]

void varDump(

$data 
)

Parameters:

$data:

[ Top ]

Documentation generated on Wed, 19 Sep 2007 05:07:17 +0200 by phpDocumentor 1.4.0a2

	default

[ class tree: default ] [ index: default ] [ all elements ]