ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
nusoap_fault Class Reference

Contains information for a SOAP fault. More...

+ Inheritance diagram for nusoap_fault:
+ Collaboration diagram for nusoap_fault:

Public Member Functions

 nusoap_fault ($faultcode, $faultactor='', $faultstring='', $faultdetail='')
 
 serialize ()
 serialize a fault 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

 $faultcode
 
 $faultactor
 
 $faultstring
 
 $faultdetail
 
- 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

Contains information for a SOAP fault.

Mainly used for returning faults from deployed functions in a server instance.

Author
Dietrich Ayala dietr.nosp@m.ich@.nosp@m.ganx4.nosp@m..com
Version
$Id$ @access public

Definition at line 1004 of file nusoap.php.

Member Function Documentation

◆ nusoap_fault()

nusoap_fault::nusoap_fault (   $faultcode,
  $faultactor = '',
  $faultstring = '',
  $faultdetail = '' 
)
constructor
Parameters
string$faultcode(SOAP-ENV:Client | SOAP-ENV:Server)
string$faultactoronly used when msg routed between multiple actors
string$faultstringhuman readable error message
mixed$faultdetaildetail, typically a string or array of string

Definition at line 1038 of file nusoap.php.

1038 {
1039 parent::nusoap_base();
1040 $this->faultcode = $faultcode;
1041 $this->faultactor = $faultactor;
1042 $this->faultstring = $faultstring;
1043 $this->faultdetail = $faultdetail;
1044 }

References $faultactor, $faultcode, $faultdetail, and $faultstring.

◆ serialize()

nusoap_fault::serialize ( )

serialize a fault

Returns
string The serialization of the fault instance. @access public

Reimplemented in soap_fault.

Definition at line 1052 of file nusoap.php.

1052 {
1053 $ns_string = '';
1054 foreach($this->namespaces as $k => $v){
1055 $ns_string .= "\n xmlns:$k=\"$v\"";
1056 }
1057 $return_msg =
1058 '<?xml version="1.0" encoding="'.$this->soap_defencoding.'"?>'.
1059 '<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"'.$ns_string.">\n".
1060 '<SOAP-ENV:Body>'.
1061 '<SOAP-ENV:Fault>'.
1062 $this->serialize_val($this->faultcode, 'faultcode').
1063 $this->serialize_val($this->faultstring, 'faultstring').
1064 $this->serialize_val($this->faultactor, 'faultactor').
1065 $this->serialize_val($this->faultdetail, 'detail').
1066 '</SOAP-ENV:Fault>'.
1067 '</SOAP-ENV:Body>'.
1068 '</SOAP-ENV:Envelope>';
1069 return $return_msg;
1070 }
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:

Field Documentation

◆ $faultactor

nusoap_fault::$faultactor

Definition at line 1016 of file nusoap.php.

Referenced by nusoap_fault().

◆ $faultcode

nusoap_fault::$faultcode

Definition at line 1010 of file nusoap.php.

Referenced by nusoap_fault().

◆ $faultdetail

nusoap_fault::$faultdetail

Definition at line 1028 of file nusoap.php.

Referenced by nusoap_fault().

◆ $faultstring

nusoap_fault::$faultstring

Definition at line 1022 of file nusoap.php.

Referenced by nusoap_fault().


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