ilBMFFault Class Reference

Inheritance diagram for ilBMFFault:

Collaboration diagram for ilBMFFault:

Public Member Functions
	ilBMFFault ($faultstring='unknown error', $faultcode='Client', $faultactor=NULL, $detail=NULL, $mode=null, $options=null)
	Constructor. More...
	message ()
	message More...
	getFault ()
	getFault More...
	getActor ()
	getActor More...
	getDetail ()
	getDetail More...
Public Member Functions inherited from PEAR_Error
	PEAR_Error ($message='unknown error', $code=null, $mode=null, $options=null, $userinfo=null)
	PEAR_Error constructor. More...
	getMode ()
	Get the error mode from an error object. More...
	getCallback ()
	Get the callback function/method from an error object. More...
	getMessage ()
	Get the error message from an error object. More...
	getCode ()
	Get error code from an error object. More...
	getType ()
	Get the name of this error/exception. More...
	getUserInfo ()
	Get additional user-supplied information. More...
	getDebugInfo ()
	Get additional debug information supplied by the application. More...
	getBacktrace ($frame=null)
	Get the call backtrace from where the error was generated. More...
	addUserInfo ($info)
	__toString ()
	toString ()
	Make a string representation of this object. More...

Additional Inherited Members
Data Fields inherited from PEAR_Error
	$error_message_prefix = ''
	$mode = PEAR_ERROR_RETURN
	$level = E_USER_NOTICE
	$code = -1
	$message = ''
	$userinfo = ''
	$backtrace = null

Detailed Description

Definition at line 37 of file class.ilBMFFault.php.

Member Function Documentation

getActor()

ilBMFFault::getActor

(

)

getActor

returns the SOAP actor for the fault

Returns

string @access public

Definition at line 117 of file class.ilBMFFault.php.

    {
        return $this->error_message_prefix;
    }

References PEAR_Error\$error_message_prefix.

getDetail()

ilBMFFault::getDetail

(

)

getDetail

returns the fault detail

Returns

string @access public

Definition at line 130 of file class.ilBMFFault.php.

    {
        return $this->userinfo;
    }

References PEAR_Error\$userinfo.

getFault()

ilBMFFault::getFault

(

)

getFault

returns a simple native php array containing the fault data

Returns

array @access public

Definition at line 90 of file class.ilBMFFault.php.

    {
        global $SOAP_OBJECT_STRUCT;
        if ($SOAP_OBJECT_STRUCT) {
            $fault =& new stdClass();
            $fault->faultcode = $this->code;
            $fault->faultstring = $this->message;
            $fault->faultactor = $this->error_message_prefix;
            $fault->detail = $this->userinfo;
            return $fault;
        }
        return array(
                'faultcode' => $this->code,
                'faultstring' => $this->message,
                'faultactor' => $this->error_message_prefix,
                'detail' => $this->userinfo
            );
    }

References PEAR_Error\$code, PEAR_Error\$error_message_prefix, PEAR_Error\$message, PEAR_Error\$userinfo, and message().

Here is the call graph for this function:

ilBMFFault()

ilBMFFault::ilBMFFault	(		$faultstring = 'unknown error',
			$faultcode = 'Client',
			$faultactor = NULL,
			$detail = NULL,
			$mode = null,
			$options = null
	)

Constructor.

Parameters

string	message string for fault
mixed	the faultcode
mixed	see PEAR::ERROR
mixed	see PEAR::ERROR
array	the userinfo array is used to pass in the SOAP actor and detail for the fault

Definition at line 50 of file class.ilBMFFault.php.

    {
        parent::PEAR_Error($faultstring, $faultcode, $mode, $options, $detail);
        if ($faultactor) $this->error_message_prefix = $faultactor;
    }

References PEAR_Error\$mode, and $options.

message()

ilBMFFault::message

(

)

message

returns a SOAP_Message class that can be sent as a server response

Returns

SOAP_Message @access public

Definition at line 64 of file class.ilBMFFault.php.

    {
        $msg =& new ilBMFBase();
        $params = array();
        $params[] =& new ilBMFValue('faultcode', 'QName', 'SOAP-ENV:'.$this->code);
        $params[] =& new ilBMFValue('faultstring', 'string', $this->message);
        $params[] =& new ilBMFValue('faultactor', 'anyURI', $this->error_message_prefix);
        if (isset($this->backtrace)) {
            $params[] =& new ilBMFValue('detail', 'string', $this->backtrace);
        } else {
            $params[] =& new ilBMFValue('detail', 'string', $this->userinfo);
        }
        
        $methodValue =& new ilBMFValue('{'.SOAP_ENVELOP.'}Fault', 'Struct', $params);
        $headers = NULL;
        return $msg->_makeEnvelope($methodValue, $headers);
    }

References $params, message(), and SOAP_ENVELOP.

Referenced by getFault(), and message().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• Services/Payment/bmf/lib/SOAP/class.ilBMFFault.php