soapval Class Reference

for creating serializable abstractions of native PHP types NOTE: this is only really used when WSDL is not available. More...

Inheritance diagram for soapval:

Collaboration diagram for soapval:

Public Member Functions
	soapval ($name='soapval', $type=false, $value=-1, $element_ns=false, $type_ns=false, $attributes=false)
	constructor
	serialize ($use='encoded')
	return serialized value
	decode ()
	decodes a soapval object into a PHP native type
	soapval ($name='soapval', $type=false, $value=-1, $element_ns=false, $type_ns=false, $attributes=false)
	constructor
	serialize ($use='encoded')
	return serialized value
	decode ()
	decodes a soapval object into a PHP native type
Public Member Functions inherited from nusoap_base
	debug ($string)
	adds debug data to the class level debug string
	expandEntities ($val)
	expands entities, e.g.
	getError ()
	returns error string if present
	setError ($str)
	sets error string
	isArraySimpleOrStruct ($val)
	detect if array is a simple array or a struct (associative array)
	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.
	serializeEnvelope ($body, $headers=false, $namespaces=array(), $style='rpc', $use='encoded')
	serialize message
	formatDump ($str)
	contractQname ($qname)
	contracts a qualified name
	expandQname ($qname)
	expands a qualified name
	getLocalPart ($str)
	returns the local part of a prefixed string returns the original string, if not prefixed
	getPrefix ($str)
	returns the prefix part of a prefixed string returns false, if not prefixed
	getNamespaceFromPrefix ($prefix)
	pass it a prefix, it returns a namespace returns false if no namespace registered with the given prefix
	getPrefixFromNamespace ($ns)
	returns the prefix for a given namespace (or prefix) or false if no prefixes registered for the given namespace
	varDump ($data)
	nusoap_base ()
	constructor
	getGlobalDebugLevel ()
	gets the global debug level, which applies to future instances
	setGlobalDebugLevel ($level)
	sets the global debug level, which applies to future instances
	getDebugLevel ()
	gets the debug level for this instance
	setDebugLevel ($level)
	sets the debug level for this instance
	debug ($string)
	adds debug data to the instance debug string with formatting
	appendDebug ($string)
	adds debug data to the instance debug string without formatting
	clearDebug ()
	clears the current debug data for this instance
&	getDebug ()
	gets the current debug data for this instance
&	getDebugAsXMLComment ()
	gets the current debug data for this instance as an XML comment this may change the contents of the debug data
	expandEntities ($val)
	expands entities, e.g.
	getError ()
	returns error string if present
	setError ($str)
	sets error string
	isArraySimpleOrStruct ($val)
	detect if array is a simple array or a struct (associative array)
	serialize_val ($val, $name=false, $type=false, $name_ns=false, $type_ns=false, $attributes=false, $use='encoded', $soapval=false)
	serializes PHP values in accordance w/ section 5.
	serializeEnvelope ($body, $headers=false, $namespaces=array(), $style='rpc', $use='encoded', $encodingStyle='http://schemas.xmlsoap.org/soap/encoding/')
	serializes a message
	formatDump ($str)
	formats a string to be inserted into an HTML stream
	contractQname ($qname)
	contracts (changes namespace to prefix) a qualified name
	expandQname ($qname)
	expands (changes prefix to namespace) a qualified name
	getLocalPart ($str)
	returns the local part of a prefixed string returns the original string, if not prefixed
	getPrefix ($str)
	returns the prefix part of a prefixed string returns false, if not prefixed
	getNamespaceFromPrefix ($prefix)
	pass it a prefix, it returns a namespace
	getPrefixFromNamespace ($ns)
	returns the prefix for a given namespace (or prefix) or false if no prefixes registered for the given namespace
	getmicrotime ()
	returns the time in ODBC canonical form with microseconds
	varDump ($data)
	Returns a string with the output of var_dump.
	__toString ()
	represents the object as a string

Data Fields
	$name
	$type
	$value
	$element_ns
	$type_ns
	$attributes
Data Fields inherited from nusoap_base
	$title = 'NuSOAP'
	$version = '0.6.7'
	$revision = '$Revision$'
	$error_str = false
	$debug_str = ''
	$charencoding = true
	$XMLSchemaVersion = 'http://www.w3.org/2001/XMLSchema'
	$soap_defencoding = 'UTF-8'
	$namespaces
	$usedNamespaces = array()
	$typemap
	$xmlEntities
	$debugLevel

Detailed Description

for creating serializable abstractions of native PHP types NOTE: this is only really used when WSDL is not available.

For creating serializable abstractions of native PHP types.

Author

Dietrich Ayala dietr.nosp@m.ich@.nosp@m.ganx4.nosp@m..com

Version

$Id$ public

This class allows element name/namespace, XSD type, and XML attributes to be associated with a value. This is extremely useful when WSDL is not used, but is also useful when WSDL is used with polymorphic types, including xsd:anyType and user-defined types.

Author

Dietrich Ayala dietr.nosp@m.ich@.nosp@m.ganx4.nosp@m..com

Version

$Id$ public

Definition at line 1495 of file nusoap.php.

Member Function Documentation

soapval::decode

(

)

decodes a soapval object into a PHP native type

Parameters

object

$soapval

optional SOAPx4 soapval object, else uses self

Returns

mixed public

Definition at line 1533 of file nusoap.php.

References $value.

                         {
                return $this->value;
        }

soapval::decode

(

)

decodes a soapval object into a PHP native type

Returns

mixed public

Definition at line 2111 of file nusoap.php.

References $value.

                         {
                return $this->value;
        }

soapval::serialize

(

$use = 'encoded'

)

return serialized value

Returns

string XML data private

Definition at line 1522 of file nusoap.php.

References nusoap_base\serialize_val().

                                           {
                return $this->serialize_val($this->value,$this->name,$this->type,$this->element_ns,$this->type_ns,$this->attributes,$use);
    }

Here is the call graph for this function:

soapval::serialize

(

$use = 'encoded'

)

return serialized value

Parameters

string

$use

The WSDL use value (encoded|literal)

Returns

string XML data public

Definition at line 2101 of file nusoap.php.

References nusoap_base\serialize_val().

                                           {
                return $this->serialize_val($this->value, $this->name, $this->type, $this->element_ns, $this->type_ns, $this->attributes, $use, true);
    }

Here is the call graph for this function:

soapval::soapval	(		$name = 'soapval',
			$type = false,
			$value = -1,
			$element_ns = false,
			$type_ns = false,
			$attributes = false
	)

constructor

Parameters

string	$name	optional name
string	$type	optional type name
mixed	$value	optional value
string	$namespace	optional namespace of value
string	$type_namespace	optional namespace of type
array	$attributes	associative array of attributes to add to element serialization public

Definition at line 1507 of file nusoap.php.

References $attributes, $element_ns, $name, $type, $type_ns, and $value.

                                                                                                                   {
                $this->name = $name;
                $this->value = $value;
                $this->type = $type;
                $this->element_ns = $element_ns;
                $this->type_ns = $type_ns;
                $this->attributes = $attributes;
    }

soapval::soapval	(		$name = 'soapval',
			$type = false,
			$value = -1,
			$element_ns = false,
			$type_ns = false,
			$attributes = false
	)

constructor

Parameters

string	$name	optional name
mixed	$type	optional type name
mixed	$value	optional value
mixed	$element_ns	optional namespace of value
mixed	$type_ns	optional namespace of type
mixed	$attributes	associative array of attributes to add to element serialization public

Definition at line 2084 of file nusoap.php.

References $attributes, $element_ns, $name, $type, $type_ns, $value, and nusoap_base\nusoap_base().

                                                                                                                   {
                parent::nusoap_base();
                $this->name = $name;
                $this->type = $type;
                $this->value = $value;
                $this->element_ns = $element_ns;
                $this->type_ns = $type_ns;
                $this->attributes = $attributes;
    }

Here is the call graph for this function:

Field Documentation

soapval::$attributes

Definition at line 2071 of file nusoap.php.

Referenced by soapval().

soapval::$element_ns

Definition at line 2057 of file nusoap.php.

Referenced by soapval().

soapval::$name

Definition at line 2036 of file nusoap.php.

Referenced by soapval().

soapval::$type

Definition at line 2043 of file nusoap.php.

Referenced by soapval().

soapval::$type_ns

Definition at line 2064 of file nusoap.php.

Referenced by soapval().

soapval::$value

Definition at line 2050 of file nusoap.php.

Referenced by decode(), and soapval().

---

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

• Services/SOAPAuth/include/nusoap.php
• webservice/soap/lib/nusoap.php