Class Report

Description

Report Class

This (abstract) class is the parent of the specific report renderers. It handles the output stream creation, sorting, and other housekeeping details.

Located in /lib/Report.php (line 11)


	
			
Direct descendents
Class Description
CSVReport CSVReport Class
DetailedReport DetailedReport Class
HTMLGroupReport HTMLGroupReport Class
HTMLReport HTMLReport Class
XMLReport XMLReport Class
Variable Summary
Method Summary
Report Report ( &$options,  &$results)
true execute ()
description, get_severity_description (integer $n)
true is_severity_sufficient (integer $level)
0, result_list_comparator (array $a, array $b)
Variables
mixed $default_extension = "html" (line 15)

The default extension used for reports of this type.

  • access: public

Redefined in descendants as:
array $options = array() (line 22)

Options parsed from the command line.

  • access: public
array $results = array() (line 36)

The results of the scan.

  • access: public
boolean $use_digital_signature = true (line 29)

Include a digital signature in the report file?

  • access: public
Methods
Constructor Report (line 38)
Report Report ( &$options,  &$results)
  • &$options
  • &$results
create_output_handle (line 73)

Creates an output handle to write the report to. If the requested file is not writeable, the same filename will be attempted to be placed in the temporary directory.

  • return: resource handle to the file
a &create_output_handle ()
execute (line 54)

The execute function renders the particular report. Since this is is an abstract class, this function should never actually be called, but should be overriden by a subclass.

  • return: iff successful.
true execute ()

Redefined in descendants as:
get_severity_description (line 97)

Translated a severity number into a description.

  • return: or 'Unknown' if not in the required range
description, get_severity_description (integer $n)
  • integer $n: severity number (1-5)
is_severity_sufficient (line 64)

Tests whether the severity is sufficient to warrant including in the output.

  • return: iff the severity is sufficient.
true is_severity_sufficient (integer $level)
  • integer $level: level in the (1-5) range.
result_list_comparator (line 114)

Compares results to sort them by severity.

  • return: 1, or -1 as per comparator requirements.
0, result_list_comparator (array $a, array $b)
  • array $a: array of data from Yasca.
  • array $b: array of data from Yasca.

Documentation generated on Mon, 28 Apr 2008 12:52:03 -0400 by phpDocumentor 1.4.0a2