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

Class: ErrorTracker

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/Errors.inc

Class Overview


contains all the errors/warnings


Author(s):

Version:

  • Release: 1.5.0a1

Copyright:

  • 2001-2008 Gregory Beaver

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 894]
contains all the errors/warnings


[ Top ]


Class Variables

$curfile =  ''

[line 909]


Type:   string


[ Top ]

$errors = array()

[line 900]

array of RecordErrors

Type:   array


[ Top ]

$lasterror =  false

[line 919]

index in $errors of last error triggered

Type:   integer|false


[ Top ]

$lastwarning =  false

[line 925]

index in $warnings of last warning triggered

Type:   integer|false


[ Top ]

$linenum =  0

[line 913]


Type:   integer


[ Top ]

$warnings = array()

[line 905]

array of RecordWarnings

Type:   array


[ Top ]



Method Detail

addError   [line 993]

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

add a new error to the $errors array
  • Todo: CS Cleanup - do I need to add $data to the method signature?

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

[ Top ]

addErrorReturn   [line 1016]

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

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?

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

[ Top ]

addWarning   [line 970]

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

add a new warning to the $warnings array
  • Todo: CS Cleanup - do I need to add $data to the method signature?

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

[ Top ]

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

[ Top ]

returnErrors   [line 1045]

array &returnErrors( )

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

[ Top ]

returnLastError   [line 1077]

string returnLastError( )

Get the error message of the last error

[ Top ]

returnLastWarning   [line 1087]

string returnLastWarning( )

Get the warning message of the last warning

[ Top ]

returnWarnings   [line 1034]

array &returnWarnings( )

Get sorted array of all warnings in parsing/conversion

[ Top ]


Documentation generated on Sun, 02 Sep 2012 00:01:30 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.