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

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
 Current error string (manipulated by getError/setError) More...
 
 $debug_str = ''
 Current debug string (manipulated by debug/appendDebug/clearDebug/getDebug/getDebugAsXMLComment) More...
 
 $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$ @access 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$ @access public

Definition at line 1495 of file nusoap.php.

Member Function Documentation

◆ decode() [1/2]

soapval::decode ( )

decodes a soapval object into a PHP native type

Parameters
object$soapvaloptional SOAPx4 soapval object, else uses self
Returns
mixed @access public

Definition at line 1533 of file nusoap.php.

1533 {
1534 return $this->value;
1535 }

References $value.

◆ decode() [2/2]

soapval::decode ( )

decodes a soapval object into a PHP native type

Returns
mixed @access public

Definition at line 2111 of file nusoap.php.

2111 {
2112 return $this->value;
2113 }

References $value.

◆ serialize() [1/2]

soapval::serialize (   $use = 'encoded')

return serialized value

Returns
string XML data @access private

Definition at line 1522 of file nusoap.php.

1522 {
1523 return $this->serialize_val($this->value,$this->name,$this->type,$this->element_ns,$this->type_ns,$this->attributes,$use);
1524 }
serialize_val($val, $name=false, $type=false, $name_ns=false, $type_ns=false, $attributes=false, $use='encoded')
Definition: nusoap.php:212

References nusoap_base\serialize_val().

+ Here is the call graph for this function:

◆ serialize() [2/2]

soapval::serialize (   $use = 'encoded')

return serialized value

Parameters
string$useThe WSDL use value (encoded|literal)
Returns
string XML data @access public

Definition at line 2101 of file nusoap.php.

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

References nusoap_base\serialize_val().

+ Here is the call graph for this function:

◆ soapval() [1/2]

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

constructor

Parameters
string$nameoptional name
string$typeoptional type name
mixed$valueoptional value
string$namespaceoptional namespace of value
string$type_namespaceoptional namespace of type
array$attributesassociative array of attributes to add to element serialization @access public

Definition at line 1507 of file nusoap.php.

1507 {
1508 $this->name = $name;
1509 $this->value = $value;
1510 $this->type = $type;
1511 $this->element_ns = $element_ns;
1512 $this->type_ns = $type_ns;
1513 $this->attributes = $attributes;
1514 }
$element_ns
Definition: nusoap.php:2057
$attributes
Definition: nusoap.php:2071

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

◆ soapval() [2/2]

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

constructor

Parameters
string$nameoptional name
mixed$typeoptional type name
mixed$valueoptional value
mixed$element_nsoptional namespace of value
mixed$type_nsoptional namespace of type
mixed$attributesassociative array of attributes to add to element serialization @access public

Definition at line 2084 of file nusoap.php.

2084 {
2085 parent::nusoap_base();
2086 $this->name = $name;
2087 $this->type = $type;
2088 $this->value = $value;
2089 $this->element_ns = $element_ns;
2090 $this->type_ns = $type_ns;
2091 $this->attributes = $attributes;
2092 }

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

Field Documentation

◆ $attributes

soapval::$attributes

Definition at line 2071 of file nusoap.php.

Referenced by soapval().

◆ $element_ns

soapval::$element_ns

Definition at line 2057 of file nusoap.php.

Referenced by soapval().

◆ $name

soapval::$name

Definition at line 2036 of file nusoap.php.

Referenced by soapval().

◆ $type

soapval::$type

Definition at line 2043 of file nusoap.php.

Referenced by soapval().

◆ $type_ns

soapval::$type_ns

Definition at line 2064 of file nusoap.php.

Referenced by soapval().

◆ $value

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: