Class Plugin_Grep

Description

The Grep Plugin is a special plugin that faciliates .grep psuedo-plugins, which are just files in the PLUGINS directory that contain necessary information to scan the target files.

The .grep files have a specific format: name = <name of plugin> (default: "Grep: <basename of .grep file>" file_type = <list,of,extensions> (default: scan all extensions) grep = <PCRE-style regular expression, without the start and end '/' delimiters (required) category = <category name> (required) category_link = <link to more information about the issue> (default: none) severity = <severity on 1-5 scale, 1=critical, 5=informational> (default: 5) description = <description of the issue> (default: none)

Located in /plugins/Grep.php (line 20)

Plugin
   |
   --Plugin_Grep
Variable Summary
Method Summary
void execute ()
void initialize ()
Variables
static mixed $union_valid_file_types (line 31)
  • access: private
mixed $category (line 25)
  • access: public
mixed $category_link (line 26)
  • access: public
mixed $description (line 28)
  • access: public

Redefinition of:
Plugin::$description
Description of this plugin (what it looks for, why it's important, how to remediate.
mixed $file_type (line 23)
  • access: public
mixed $grep (line 24)
  • access: public
mixed $is_multi_target = true (line 29)
  • access: public

Redefinition of:
Plugin::$is_multi_target
True iff this object is to be only invoked once. The object itself should prevent multiple executions.
mixed $name (line 22)
  • access: public
mixed $severity = 5 (line 27)
  • access: public
mixed $valid_file_types = array() (line 21)
  • access: public

Redefinition of:
Plugin::$valid_file_types
Valid file types that this Plugin can operate on.

Inherited Variables

Inherited from Plugin

Plugin::$context_size
Plugin::$filename
Plugin::$file_contents
Plugin::$initialized
Plugin::$is_valid_filetype
Plugin::$result_list
Methods
execute (line 46)
void execute ()

Redefinition of:
Plugin::execute()
This function should not be called, since this class is abstract. The execute() function should be overridden by child classes.
initialize (line 36)

Re-initializes the variables back to their original state.

void initialize ()

Inherited Methods

Inherited From Plugin

Plugin::Plugin()
Plugin::check_for_java()
Plugin::destructor()
Plugin::execute()
Plugin::run()

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