$curfile = '' (line 909)

Data type : string

$errors = array() (line 900)

Data type : array

array of RecordErrors

$lasterror = false (line 919)

Data type : integer|false

index in $errors of last error triggered

$lastwarning = false (line 925)

Data type : integer|false

index in $warnings of last warning triggered

$linenum = 0 (line 913)

Data type : integer

$warnings = array() (line 905)

Data type : array

array of RecordWarnings

Method addError (line 993)

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

add a new error to the $errors array

Parameters

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

Info

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

Method addErrorReturn (line 1016)

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

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

Parameters

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

Info

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

Method addWarning (line 970)

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

add a new warning to the $warnings array

Parameters

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

Info

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

Method handleEvent (line 940)

void handleEvent( integer $num, mixed $data)

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

Parameters

• 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

Info

Method returnErrors (line 1045)

array &returnErrors( )

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

Info

Method returnLastError (line 1077)

string returnLastError( )

Get the error message of the last error

Info

Method returnLastWarning (line 1087)

string returnLastWarning( )

Get the warning message of the last warning

Info

Method returnWarnings (line 1034)

array &returnWarnings( )

Get sorted array of all warnings in parsing/conversion

Info