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

Class: RecordWarning

Source Location: /phpDocumentor/Errors.inc

Class Overview


encapsulates warning information


Author(s):

Version:

  • Release: @VER@

Copyright:

  • 2001-2008 Gregory Beaver

Variables

Methods


Child classes:

RecordError
encapsulates error information

Class Details



[ Top ]


Class Variables

$data =

[line 767]

error string


Type:   string


[ Top ]

$file =  false

[line 757]

file this error occurred in


Type:   string


[ Top ]

$linenum =

[line 762]

line number of the file this error occurred in


Type:   integer


[ Top ]

$num =

[line 773]

error number



Tags:

see:  Errors.inc

Type:   string


[ Top ]

$type =  'phpDocumentor_warning_descrip'

[line 752]

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


Type:   string


[ Top ]



Class Methods


constructor RecordWarning [line 785]

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

Constructor



Tags:

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


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,

[ Top ]

method output [line 809]

void output( [string $string = false])

prints the warning



Overridden in child classes as:

RecordError::output()
prints the error

Parameters:

string   $string   the warning to print

[ Top ]


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