Class RecordWarning

Description

encapsulates warning information

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


	
			
Direct descendents
Class Description
 class RecordError encapsulates error information
Variable Summary
 string $data
 string $file
 integer $linenum
 string $num
 string $type
Method Summary
 RecordWarning RecordWarning (string $file, integer $linenum, integer $num, string $data...)
 void output ([string $string = false])
Variables
string $data (line 767)

error string

string $file = false (line 757)

file this error occurred in

integer $linenum (line 762)

line number of the file this error occurred in

string $num (line 773)

error number

string $type = 'phpDocumentor_warning_descrip' (line 752)

name of global variable that descriptors for this warning/error is kept


Redefined in descendants as:
  • RecordError::$type : name of global variable that descriptors for this warning/error is kept
Methods
Constructor RecordWarning (line 785)

Constructor

  • todo: CS Cleanup - do I need to add $data to the method signature? to sprintf based on the error number
RecordWarning RecordWarning (string $file, integer $linenum, integer $num, string $data...)
  • string $file: filename this error occurred in ($file)
  • integer $linenum: line number this error occurred on ($linenum)
  • integer $num: Error number defined in Errors.inc
  • string $data...: variable number of strings, up to 4,
output (line 809)

prints the warning

void output ([string $string = false])
  • string $string: the warning to print

Redefined in descendants as:

Documentation generated on Mon, 05 Dec 2011 21:37:41 -0600 by phpDocumentor 1.4.4