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

Class: ErrorTracker

Source Location: /phpDocumentor/Errors.inc

Class ErrorTracker

Class Overview

contains all the errors/warnings

Located in /phpDocumentor/Errors.inc [line 894]



		
				Author(s):
		
		
		API Tags:
See:  ErrorTracker::$errors, ErrorTracker::$warnings

Information Tags:
Version:  Release: @VER@
Copyright:  2001-2008 Gregory Beaver
Link:  http://pear.php.net/PhpDocumentor
Link:  http://www.phpdoc.org
Todo:  CS cleanup - change package to PhpDocumentor
License:  LGPL

Properties

Methods

[ Top ]
Property Summary
string   $curfile  
array   $errors   array of RecordErrors
integer|false   $lasterror   index in $errors of last error triggered
integer|false   $lastwarning   index in $warnings of last warning triggered
integer   $linenum  
array   $warnings   array of RecordWarnings

[ Top ]
Method Summary
void   addError()   add a new error to the $errors array
void   addErrorReturn()   add a new error to the $errors array and returns the error string
void   addWarning()   add a new warning to the $warnings array
void   handleEvent()   This function subscribes to two events in the Parser in order to keep track of line number information and file name.
array   &returnErrors()   Get sorted array of all non-fatal errors in parsing/conversion
string   returnLastError()   Get the error message of the last error
string   returnLastWarning()   Get the warning message of the last warning
array   &returnWarnings()   Get sorted array of all warnings in parsing/conversion

[ Top ]
Properties
string   $curfile = '' [line 909]

[ Top ]
array   $errors = array() [line 900]

array of RecordErrors


[ Top ]
integer|false   $lasterror = false [line 919]

index in $errors of last error triggered


[ Top ]
integer|false   $lastwarning = false [line 925]

index in $warnings of last warning triggered


[ Top ]
integer   $linenum = 0 [line 913]

[ Top ]
array   $warnings = array() [line 905]

array of RecordWarnings


[ Top ]
Methods
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

Information Tags:
Todo:  CS Cleanup - do I need to add $data to the method signature?

[ Top ]
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

Information Tags:
Todo:  CS Cleanup - do I need to add $data to the method signature?

[ Top ]
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

Information Tags:
Todo:  CS Cleanup - do I need to add $data to the method signature?

[ 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 Tue, 06 Dec 2011 07:18:23 -0600 by phpDocumentor 1.4.4