ILIAS  Release_3_10_x_branch Revision 61812
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Data Fields
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
 serialize ()
 serialize a fault
 soap_fault ($faultcode, $faultactor='', $faultstring='', $faultdetail='')
 constructor
 serialize ()
 serialize a fault
 soap_fault ($faultcode, $faultactor='', $faultstring='', $faultdetail='')
 constructor
 serialize ()
 serialize a fault
 __toString ()
- 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')
 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.
 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')
 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.

Data Fields

 $faultcode
 $faultactor
 $faultstring
 $faultdetail
- Data Fields inherited from nusoap_base
 $title = 'NuSOAP'
 $version = '0.6.7'
 $revision = '$Revision: 11808 $'
 $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.

Contains information for a SOAP fault.

Author
Dietrich Ayala dietr.nosp@m.ich@.nosp@m.ganx4.nosp@m..com
Version
Id:
nusoap.php 11808 2006-08-08 09:57:04Z akill

public

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:
class.soap_fault.php 14918 2007-10-07 17:02:40Z rkuester

public

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:
nusoap.php 16669 2008-05-20 18:28:36Z rkuester

public

Definition at line 669 of file nusoap.php.

Member Function Documentation

soap_fault::__toString ( )

Definition at line 984 of file nusoap.php.

{
return spl_object_hash($this);
}
soap_fault::serialize ( )

serialize a fault

Returns
string The serialization of the fault instance. public

Definition at line 62 of file class.soap_fault.php.

References nusoap_base\serialize_val().

{
$ns_string = '';
foreach($this->namespaces as $k => $v){
$ns_string .= "\n xmlns:$k=\"$v\"";
}
$return_msg =
'<?xml version="1.0" encoding="'.$this->soap_defencoding.'"?>'.
'<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"'.$ns_string.">\n".
'<SOAP-ENV:Body>'.
'<SOAP-ENV:Fault>'.
$this->serialize_val($this->faultcode, 'faultcode').
$this->serialize_val($this->faultactor, 'faultactor').
$this->serialize_val($this->faultstring, 'faultstring').
$this->serialize_val($this->faultdetail, 'detail').
'</SOAP-ENV:Fault>'.
'</SOAP-ENV:Body>'.
'</SOAP-ENV:Envelope>';
return $return_msg;
}

+ Here is the call graph for this function:

soap_fault::serialize ( )

serialize a fault

public

Definition at line 696 of file nusoap.php.

{
$ns_string = '';
foreach($this->namespaces as $k => $v){
$ns_string .= "\n xmlns:$k=\"$v\"";
}
$return_msg =
'<?xml version="1.0" encoding="'.$this->soap_defencoding.'"?>'.
'<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"'.$ns_string.">\n".
'<SOAP-ENV:Body>'.
'<SOAP-ENV:Fault>'.
'<faultcode>'.$this->expandEntities($this->faultcode).'</faultcode>'.
'<faultactor>'.$this->expandEntities($this->faultactor).'</faultactor>'.
'<faultstring>'.$this->expandEntities($this->faultstring).'</faultstring>'.
'<detail>'.$this->serialize_val($this->faultdetail).'</detail>'.
'</SOAP-ENV:Fault>'.
'</SOAP-ENV:Body>'.
'</SOAP-ENV:Envelope>';
return $return_msg;
}
soap_fault::serialize ( )

serialize a fault

Returns
string The serialization of the fault instance. public

Definition at line 964 of file nusoap.php.

References nusoap_base\serialize_val().

{
$ns_string = '';
foreach($this->namespaces as $k => $v){
$ns_string .= "\n xmlns:$k=\"$v\"";
}
$return_msg =
'<?xml version="1.0" encoding="'.$this->soap_defencoding.'"?>'.
'<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"'.$ns_string.">\n".
'<SOAP-ENV:Body>'.
'<SOAP-ENV:Fault>'.
$this->serialize_val($this->faultcode, 'faultcode').
$this->serialize_val($this->faultactor, 'faultactor').
$this->serialize_val($this->faultstring, 'faultstring').
$this->serialize_val($this->faultdetail, 'detail').
'</SOAP-ENV:Fault>'.
'</SOAP-ENV:Body>'.
'</SOAP-ENV:Envelope>';
return $return_msg;
}

+ Here is the call graph for this function:

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
mixed$faultdetaildetail, typically a string or array of string

Definition at line 48 of file class.soap_fault.php.

References $faultactor, $faultcode, $faultdetail, $faultstring, and nusoap_base\nusoap_base().

{
parent::nusoap_base();
$this->faultcode = $faultcode;
$this->faultactor = $faultactor;
$this->faultstring = $faultstring;
$this->faultdetail = $faultdetail;
}

+ Here is the call graph for this function:

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.

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

{
$this->faultcode = $faultcode;
$this->faultactor = $faultactor;
$this->faultstring = $faultstring;
$this->faultdetail = $faultdetail;
}
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
mixed$faultdetaildetail, typically a string or array of string

Definition at line 950 of file nusoap.php.

References $faultactor, $faultcode, $faultdetail, $faultstring, and nusoap_base\nusoap_base().

{
parent::nusoap_base();
$this->faultcode = $faultcode;
$this->faultactor = $faultactor;
$this->faultstring = $faultstring;
$this->faultdetail = $faultdetail;
}

+ Here is the call graph for this function:

Field Documentation

soap_fault::$faultactor

Definition at line 672 of file nusoap.php.

Referenced by soap_fault().

soap_fault::$faultcode

Definition at line 671 of file nusoap.php.

Referenced by soap_fault().

soap_fault::$faultdetail

Definition at line 674 of file nusoap.php.

Referenced by soap_fault().

soap_fault::$faultstring

Definition at line 673 of file nusoap.php.

Referenced by soap_fault().

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