Contains information for a SOAP fault. More...

Inheritance diagram for nusoap_fault:

Collaboration diagram for nusoap_fault:

Public Member Functions
	__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_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

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$ public

Definition at line 1004 of file nusoap.php.

Constructor & Destructor Documentation

◆ __construct()

nusoap_fault::__construct	(	$faultcode,
		$faultactor = `''`,
		$faultstring = `''`,
		$faultdetail = `''`
	)

constructor

Parameters

string	$faultcode	(SOAP-ENV:Client \| SOAP-ENV:Server)
string	$faultactor	only used when msg routed between multiple actors
string	$faultstring	human readable error message
mixed	$faultdetail	detail, typically a string or array of string

Definition at line 1038 of file nusoap.php.

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

Member Function Documentation

◆ serialize()

nusoap_fault::serialize ( )

serialize a fault

Returns: string The serialization of the fault instance. public

Definition at line 1052 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->faultstring, 'faultstring').
                                         $this->serialize_val($this->faultactor, 'faultactor').
                                         $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:

Field Documentation

◆ $faultactor

nusoap_fault::$faultactor

Definition at line 1016 of file nusoap.php.

◆ $faultcode

nusoap_fault::$faultcode

Definition at line 1010 of file nusoap.php.

◆ $faultdetail

nusoap_fault::$faultdetail

Definition at line 1028 of file nusoap.php.

◆ $faultstring

nusoap_fault::$faultstring

Definition at line 1022 of file nusoap.php.

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

webservice/soap/lib/nusoap.php

Public Member Functions

Data Fields