Main Page | Class Hierarchy | Class List | File List | Class Members | File Members | Related Pages

JError Class Reference

Inheritance diagram for JError:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 JError ($code, $msg, $type=JERROR_DEFAULT, $extra=null)
 GetCode ()
 GetMessage ()
 GetType ()
 GetExtraInfo ()
 ToString ()

Public Attributes

 $code
 The concrete error code.

 $msg
 A string describing the error.

 $type
 The type of the error.

 $extra
 Extra info associated to the error.


Detailed Description

Class used for the treatment of errors.

When an error happened, an object of this class should be returned. This allows that the caller function is able to do a more powerful treatment of the error.

Definition at line 16 of file JError.class.php.


Constructor & Destructor Documentation

JError::JError code,
msg,
type = JERROR_DEFAULT,
extra = null
 

The constructor.

It just initializes the attributes whith the parameters.

Definition at line 28 of file JError.class.php.

References $code, $extra, $msg, and $type.


Member Function Documentation

JError::GetCode  ) 
 

Gets the error code.

Returns:
string

Definition at line 40 of file JError.class.php.

JError::GetExtraInfo  ) 
 

Gets the error extra info.

Returns:
string

Definition at line 67 of file JError.class.php.

JError::GetMessage  ) 
 

Gets the error message.

Returns:
string

Definition at line 49 of file JError.class.php.

JError::GetType  ) 
 

Gets the error type.

Returns:
string

Definition at line 58 of file JError.class.php.

JError::ToString  ) 
 

Gets a string describing the error

Returns:
string

Definition at line 76 of file JError.class.php.

References $msg.


Member Data Documentation

JError::$code
 

The concrete error code.

Definition at line 18 of file JError.class.php.

Referenced by JSystemError::_GetMessage(), and JError().

JError::$extra
 

Extra info associated to the error.

Definition at line 21 of file JError.class.php.

Referenced by JError().

JError::$msg
 

A string describing the error.

Definition at line 19 of file JError.class.php.

Referenced by JSystemError::_GetMessage(), JError(), JSystemError::JSystemError(), and ToString().

JError::$type
 

The type of the error.

Definition at line 20 of file JError.class.php.

Referenced by JError().


The documentation for this class was generated from the following file:
Generated on Wed Nov 19 20:29:40 2003 for James by doxygen 1.3.4