Class RecordWarning

(line 746)

Description


Located in File: /phpDocumentor/Errors.inc

encapsulates warning information


Classes extended from RecordWarning:
RecordError
encapsulates error information

Class Variables

Summary:
string $data
string $file
integer $linenum
string $num
string $type

$data (line 767)

Data type : string

error string

$file = false (line 757)

Data type : string

file this error occurred in

$linenum (line 762)

Data type : integer

line number of the file this error occurred in

$num (line 773)

Data type : string

error number

$type = 'phpDocumentor_warning_descrip' (line 752)

Data type : string

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

Class Constants

Summary:

Method Detail

Summary:
RecordWarning RecordWarning (string $file, integer $linenum, integer $num, string $data...)
void output ([string $string = false])

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,

Info

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

Method output (line 809)

void output( [string $string = false])

Overridden in child classes as:

RecordError::output()
prints the error

prints the warning

Parameters

  • string $string: the warning to print

Info

Inherited Variables

Inherited Class Variable Summary

Inherited Methods

Inherited Method Summary


Documentation generated on Mon, 05 Dec 2011 21:26:30 -0600 by phpDocumentor 1.4.4