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

Class: RecordWarning

Source Location: /phpDocumentor/Errors.inc

Class RecordWarning

Class Overview

encapsulates warning information

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



		
				Author(s):
		
		
		
Information Tags:
Version:  Release: @[email protected]
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 ]
Descendants
Child Class Description
RecordError encapsulates error information

[ Top ]
Property Summary
string   $data   error string
string   $file   file this error occurred in
integer   $linenum   line number of the file this error occurred in
string   $num   error number
string   $type   name of global variable that descriptors for this warning/error is kept

[ Top ]
Method Summary
RecordWarning   RecordWarning()   Constructor
void   output()   prints the warning

[ Top ]
Properties
string   $data [line 767]

error string


[ Top ]
string   $file = false [line 757]

file this error occurred in


[ Top ]
integer   $linenum [line 762]

line number of the file this error occurred in


[ Top ]
string   $num [line 773]

error number

API Tags:
See:  Errors.inc


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

[ Top ]
Methods
Constructor RecordWarning  [line 785]

  RecordWarning RecordWarning( string $file, integer $linenum, integer $num, string $data...  )

Constructor

Parameters:
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,

Information Tags:
Todo:  CS Cleanup - do I need to add $data to the method signature? to sprintf based on the error number

[ Top ]
output  [line 809]

  void output( [string $string = false]  )

prints the warning

Parameters:
string   $string:  the warning to print


Redefined in descendants as:

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:18:24 -0600 by phpDocumentor 1.4.4