Class: RecordWarning

Source Location: /phpDocumentor/Errors.inc

Class Overview [line 746]


encapsulates warning information

Author(s):

Version:

  • Release: @VER@

Copyright:

  • 2001-2008 Gregory Beaver

Variables

Constants

Methods


Child classes:

RecordError
encapsulates error information

Inherited Variables

Inherited Constants

Inherited Methods



Class Details

encapsulates warning information

Tags:

[ Top ]


Class Variables

$data

[line 767]

error string

Type: string

Overrides:

[ Top ]

$file =  false

[line 757]

file this error occurred in

Type: string

Overrides:

[ Top ]

$linenum

[line 762]

line number of the file this error occurred in

Type: integer

Overrides:

[ Top ]

$num

[line 773]

error number

Tags:

Type: string

Overrides:

[ Top ]

$type =  'phpDocumentor_warning_descrip'

[line 752]

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

Type: string

Overrides:

[ Top ]


Class Methods

RecordWarning

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

[line 785]

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 ]

output

void output( [string $string = false])

[line 809]

prints the warning

Overridden in child classes as:

RecordError::output()
prints the error

Parameters:

  • string $string - the warning to print

[ Top ]


Class Constants


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