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

Class: RecordWarning

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/Errors.inc

Class Overview


encapsulates warning information


Author(s):

Version:

  • Release: 1.5.0a1

Copyright:

  • 2001-2008 Gregory Beaver

Variables

Methods


Child classes:

RecordError
encapsulates error information

Inherited Variables

Inherited Methods


Class Details

[line 746]
encapsulates warning information


[ 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

Type:   string


[ Top ]

$type =  'phpDocumentor_warning_descrip'

[line 752]

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

Type:   string


[ Top ]



Method Detail

RecordWarning (Constructor)   [line 785]

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

Constructor
  • 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 ]

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 Sun, 02 Sep 2012 00:01:31 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.