ILIAS  release_5-3 Revision v5.3.23-19-g915713cf615
soap_fault Class Reference

soap_fault class, allows for creation of faults mainly used for returning faults from deployed functions in a server instance. More...

+ Inheritance diagram for soap_fault:
+ Collaboration diagram for soap_fault:

Public Member Functions

 soap_fault ($faultcode, $faultactor='', $faultstring='', $faultdetail='')
 constructor More...
 
 serialize ()
 serialize a fault More...
 
- Public Member Functions inherited from nusoap_fault
 __construct ($faultcode, $faultactor='', $faultstring='', $faultdetail='')
 constructor More...
 
 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')
 serializes PHP values in accordance w/ section 5. More...
 
 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)
 
 __construct ()
 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)
 serializes PHP values in accordance w/ section 5. More...
 
 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_fault
 $faultcode
 
 $faultactor
 
 $faultstring
 
 $faultdetail
 
- 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

soap_fault class, allows for creation of faults mainly used for returning faults from deployed functions in a server instance.

Backward compatibility.

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

Definition at line 669 of file nusoap.php.

Member Function Documentation

◆ serialize()

soap_fault::serialize ( )

serialize a fault

public

Definition at line 696 of file nusoap.php.

696  {
697  $ns_string = '';
698  foreach($this->namespaces as $k => $v){
699  $ns_string .= "\n xmlns:$k=\"$v\"";
700  }
701  $return_msg =
702  '<?xml version="1.0" encoding="'.$this->soap_defencoding.'"?>'.
703  '<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"'.$ns_string.">\n".
704  '<SOAP-ENV:Body>'.
705  '<SOAP-ENV:Fault>'.
706  '<faultcode>'.$this->expandEntities($this->faultcode).'</faultcode>'.
707  '<faultactor>'.$this->expandEntities($this->faultactor).'</faultactor>'.
708  '<faultstring>'.$this->expandEntities($this->faultstring).'</faultstring>'.
709  '<detail>'.$this->serialize_val($this->faultdetail).'</detail>'.
710  '</SOAP-ENV:Fault>'.
711  '</SOAP-ENV:Body>'.
712  '</SOAP-ENV:Envelope>';
713  return $return_msg;
714  }

◆ soap_fault()

soap_fault::soap_fault (   $faultcode,
  $faultactor = '',
  $faultstring = '',
  $faultdetail = '' 
)

constructor

Parameters
string$faultcode(client | server)
string$faultactoronly used when msg routed between multiple actors
string$faultstringhuman readable error message
string$faultdetail

Definition at line 684 of file nusoap.php.

684  {
685  $this->faultcode = $faultcode;
686  $this->faultactor = $faultactor;
687  $this->faultstring = $faultstring;
688  $this->faultdetail = $faultdetail;
689  }

Field Documentation

◆ $faultactor

soap_fault::$faultactor

Definition at line 672 of file nusoap.php.

◆ $faultcode

soap_fault::$faultcode

Definition at line 671 of file nusoap.php.

◆ $faultdetail

soap_fault::$faultdetail

Definition at line 674 of file nusoap.php.

◆ $faultstring

soap_fault::$faultstring

Definition at line 673 of file nusoap.php.


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