Docs For Class ModuleSearch

Class ModuleSearch

Description

Holds search conditions for module searches

Module are searched by walking through all available modules recursively and evaluating the search conditions stored in instances of this class on them.

Should not be used. This approach scales really bad. Use the module indexer instead.

Located in /phpsatk-lib/core/15.module.search.php (line 43)

Method Summary

void addClass (string $class)

void addID (string $id)

void addProvides (string $virtual, integer $version)

void addVersion (string $version, [string $comparison = 'ge'])

boolean evaluate (ModuleItem $module)

string __toString ()

Methods

addClass (line 99)

Adds a class condition

Searches for a module containing the specified class

access: public

void addClass (string $class)

string $class: Class name

addID (line 72)

Adds a ID condition

access: public

void addID (string $id)

string $id: Module-ID

addProvides (line 86)

Adds a 'provides' condition

Provides means that the module searched for has to provide a virtual module specified.

access: public

void addProvides (string $virtual, integer $version)

string $virtual: Virtual module
integer $version: Virtual module version

addVersion (line 61)

Adds a new version condition

For information on version and comparison operator see: http://php.net/version_compare

access: public

void addVersion (string $version, [string $comparison = 'ge'])

string $version: Version
string $comparison: Comparison operator

evaluate (line 113)

Evaluates whether a the passed module matches the conditions

This function checks for all previously added conditions using the evaluate*() functions.

access: public

boolean evaluate (ModuleItem $module)

ModuleItem $module: Module to check

__toString (line 209)

Creates a textual representation of search conditions for debugging purposes

access: public

string __toString ()

Documentation generated on Mon, 21 May 2007 10:34:38 +0200 by phpDocumentor 1.3.0RC5