Docs For Class ErrorTracker

Description

contains all the errors/warnings

author: Greg Beaver <[email protected]>
version: Release: @VER@
copyright: 2001-2008 Gregory Beaver
see: ErrorTracker::$errors, ErrorTracker::$warnings
link: http://pear.php.net/PhpDocumentor
link: http://www.phpdoc.org
todo: CS cleanup - change package to PhpDocumentor
license: LGPL

Located in /phpDocumentor/Errors.inc (line 894)

Variable Summary

string $curfile

array $errors

integer|false $lasterror

integer|false $lastwarning

integer $linenum

array $warnings

Method Summary

void addError (integer $num, string $data...)

void addErrorReturn (integer $num, string $data...)

void addWarning (integer $num, string $data...)

void handleEvent (integer $num, mixed $data)

array &returnErrors ()

string returnLastError ()

string returnLastWarning ()

array &returnWarnings ()

Variables

string $curfile = '' (line 909)

array $errors = array() (line 900)

array of RecordErrors

integer|false $lasterror = false (line 919)

index in $errors of last error triggered

integer|false $lastwarning = false (line 925)

index in $warnings of last warning triggered

integer $linenum = 0 (line 913)

array $warnings = array() (line 905)

array of RecordWarnings

Methods

addError (line 993)

add a new error to the $errors array

todo: CS Cleanup - do I need to add $data to the method signature?

void addError (integer $num, string $data...)

integer $num: error number from Errors.inc
string $data...: up to 4 string parameters to sprintf() into the error string for error number $num

addErrorReturn (line 1016)

add a new error to the $errors array and returns the error string

todo: CS Cleanup - do I need to add $data to the method signature?

void addErrorReturn (integer $num, string $data...)

integer $num: error number from Errors.inc
string $data...: up to 4 string parameters to sprintf() into the error string for error number $num

addWarning (line 970)

add a new warning to the $warnings array

todo: CS Cleanup - do I need to add $data to the method signature?

void addWarning (integer $num, string $data...)

integer $num: error number from Errors.inc
string $data...: up to 4 string parameters to sprintf() into the error string for error number $num

handleEvent (line 940)

This function subscribes to two events in the Parser in order to keep track of line number information and file name.

void handleEvent (integer $num, mixed $data)

integer $num: parser-passed event (see PHPDOCUMENTOR_EVENT_NEWLINENUM, PHPDOCUMENTOR_EVENT_NEWFILE)
mixed $data: either a line number if $num is PHPDOCUMENTOR_EVENT_NEWLINENUM or a file name if $num is PHPDOCUMENTOR_EVENT_NEWFILE

returnErrors (line 1045)

Get sorted array of all non-fatal errors in parsing/conversion

array &returnErrors ()

returnLastError (line 1077)

Get the error message of the last error

string returnLastError ()

returnLastWarning (line 1087)

Get the warning message of the last warning

string returnLastWarning ()

returnWarnings (line 1034)

Get sorted array of all warnings in parsing/conversion

array &returnWarnings ()