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

Class: RecordWarning

Source Location: /PhpDocumentor-1.2.0beta2/phpDocumentor/Errors.inc

Class Overview


encapsulates warning information


Variables

Methods


Child classes:

RecordError
encapsulates error information

Inherited Variables

Inherited Methods


Class Details

[line 326]
encapsulates warning information


[ Top ]


Class Variables

$data =

[line 347]

error string

Type:   string


[ Top ]

$file =  false

[line 337]

file this error occurred in

Type:   string


[ Top ]

$linenum =

[line 342]

line number of the file this error occurred in

Type:   integer


[ Top ]

$num =

[line 353]

error number

Type:   string


[ Top ]

$type =  'phpDocumentor_warning_descrip'

[line 332]

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

Type:   string


[ Top ]



Method Detail

RecordWarning (Constructor)   [line 360]

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


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, to sprintf based on the error number

[ Top ]

output   [line 381]

void output( [mixed $string = false])

prints the warning

Overridden in child classes as:

RecordError::output()
prints the error
RecordException::output()

[ Top ]


Documentation generated on Fri, 30 Apr 2004 22:09:43 +0200 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.