Class: patError

Source Location: /includes/patTemplate/patError.php

Class patError

Class Overview

patError error object used by the patFormsError manager as error messages container for precise error management.

$Id: patError.php 49 2005-09-15 02:55:27Z rhuk $

Located in /includes/patTemplate/patError.php [line 27]

Author(s):

gERD Schaufelberger <gerd@php-tools.net>
Stephan Schmidt <schst@php-tools.net>
Sebastian Mordziol <argh@php-tools.net>

API Tags:

Access:

public

Information Tags:

Version:	0.3
Link:	http://www.php-tools.net
License:	LGPL

Properties

Methods

[ Top ]

Property Summary

array	$args	stores the arguments the method that the error occurred in had received.
mixed	$backtrace	stores the complete debug backtrace (if your PHP version has the debug_backtrace function)
string	$class	stores the name of the class (if any) the error occurred in.
string	$code	stores the code of the error
string	$file	stores the filename of the file the error occurred in.
string	$function	stores the name of the method the error occurred in
string	$info	additional info that is relevant for the developer of the script (e.g. if a database connect fails, the dsn used) and that the end-user should not see.
string	$level	stores the error level for this error
integer	$line	stores the line number the error occurred in.
string	$message	stores the error message - this is the message that can also be shown the user if need be.
string	$type	stores the type of error, as it is listed in the error backtrace

[ Top ]

Method Summary

patError	__construct()	constructor - used to set up the error with all needed error details.
patError	patError()	constructor, wrapper for the upcoming PHP5 constructors for upward compatibility.
array	getBacktrace()	get the backtrace
string\|integer	getCode()	recieve error code
string	getFile()	get the filename in which the error occured
mixed	getInfo()	retrieves the additional error information (information usually only relevant for developers)
int	getLevel()	returns the error level of the error - corresponds to the PHP error levels (E_ALL, E_NOTICE...)
integer	getLine()	get the line number in which the error occured
string	getMessage()	retrieves the error message

[ Top ]

Properties

array $args = array() [line 110]

stores the arguments the method that the error occurred in had received.

API Tags:

Access:

private

[ Top ]

mixed $backtrace = false [line 119]

stores the complete debug backtrace (if your PHP version has the debug_backtrace function)

API Tags:

Access:

private

[ Top ]

string $class = '' [line 94]

stores the name of the class (if any) the error occurred in.

API Tags:

Access:

private

[ Top ]

string $code = null [line 43]

stores the code of the error

API Tags:

Access:

private

[ Top ]

string $file = '' [line 70]

stores the filename of the file the error occurred in.

API Tags:

Access:

private

[ Top ]

string $function = '' [line 86]

stores the name of the method the error occurred in

API Tags:

Access:

private

[ Top ]

string $info = '' [line 62]

additional info that is relevant for the developer of the script (e.g. if a database connect fails, the dsn used) and that the end-user should not see.

API Tags:

Access:

private

[ Top ]

string $level = null [line 35]

stores the error level for this error

API Tags:

Access:

private

[ Top ]

integer $line = 0 [line 78]

stores the line number the error occurred in.

API Tags:

Access:

private

[ Top ]

string $message = null [line 52]

stores the error message - this is the message that can also be shown the user if need be.

API Tags:

Access:

private

[ Top ]

string $type = '' [line 102]

stores the type of error, as it is listed in the error backtrace

API Tags:

Access:

private

[ Top ]

Methods

Constructor __construct [line 147]

patError __construct(
int
$level, string
$code, string
$msg, [string
$info = null] 
)

constructor - used to set up the error with all needed error details.

Parameters:

int	$level:	The error level (use the PHP constants E_ALL, E_NOTICE etc.).
string	$code:	The error code from the application
string	$msg:	The error message
string	$info:	Optional: The additional error information.

API Tags:

Access:

public

Information Tags:

Todo:

all calls to patErrorManager::raise* should not be included in backtrace

[ Top ]

Constructor patError [line 132]

patError patError(
int
$level, string
$code, string
$msg, [string
$info = null] 
)

constructor, wrapper for the upcoming PHP5 constructors for upward compatibility.

Parameters:

int	$level:	The error level (use the PHP constants E_ALL, E_NOTICE etc.).
string	$code:	The error code from the application
string	$msg:	The error message
string	$info:	Optional: The additional error information.

API Tags:

See:	patError::__construct()
Access:	public

[ Top ]

getBacktrace [line 255]

array getBacktrace(
[
$formatted = false] 
)

get the backtrace

This is only possible, if debug_backtrace() is available.

Parameters:

$formatted:

API Tags:

Return:	backtrace
See:	patError::$backtrace
Access:	public

[ Top ]

getCode [line 241]

string|integer getCode(
)

recieve error code

API Tags:

Return:	error code (may be a string or an integer)
See:	patError::$code
Access:	public

[ Top ]

getFile [line 278]

string getFile(
)

get the filename in which the error occured

This is only possible, if debug_backtrace() is available.

API Tags:

Return:	filename
See:	patError::$file
Access:	public

[ Top ]

getInfo [line 229]

mixed getInfo(
)

retrieves the additional error information (information usually only relevant for developers)

API Tags:

Return:	The additional information
See:	patError::$info
Access:	public

[ Top ]

getLevel [line 203]

int getLevel(
)

returns the error level of the error - corresponds to the PHP error levels (E_ALL, E_NOTICE...)

API Tags:

Return:	The error level
See:	patError::$level
Access:	public

[ Top ]

getLine [line 292]

integer getLine(
)

get the line number in which the error occured

This is only possible, if debug_backtrace() is available.

API Tags:

Return:	line number
See:	patError::$line
Access:	public

[ Top ]

getMessage [line 216]

string getMessage(
)

retrieves the error message

API Tags:

Return:	The stored error message
See:	patError::$message
Access:	public

[ Top ]

The site fititnt.org is not affiliated with or endorsed by the Joomla! Project or Open Source Matters. If you are looking for official documentation, visit api.joomla.org and docs.joomla.org.

Documentation generated on Mon, 26 Oct 2009 22:55:01 -0200 by phpDocumentor 1.4.3

Visit fititnt.org, and look for some extension or more Joomla Framework info	patError

[ class tree: patError ] [ index: patError ] [ all elements ]