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 ()
Data Fields
	$faultcode
	$faultactor
	$faultstring
	$faultdetail

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 <dietrich@ganx4.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 <dietrich@ganx4.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 <dietrich@ganx4.com>

Version:

Id:: nusoap.php 16602 2008-05-08 14:27:44Z 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 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::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::soap_fault	(	$	faultcode,
		$	faultactor = `''`,
		$	faultstring = `''`,
		$	faultdetail = `''`
	)

constructor

Parameters:

	string	$faultcode (client \| server)
	string	$faultactor only used when msg routed between multiple actors
	string	$faultstring human 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	$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 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:

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

constructor

Parameters:

	string	$faultcode (client \| 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 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:

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:

Services/SOAPAuth/include/nusoap.php
webservice/soap/lib/class.soap_fault.php
webservice/soap/lib/nusoap.php

soap_fault Class Reference

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

Field Documentation