Docs For Class ModuleIndexer

Description

Module Indexer

This class builds indexing lists of modules and classes, dramatically speeding up simple module searches.

Located in /phpsatk-lib/core/15.module.indexer.php (line 39)

Method Summary

void addClass (string $name, ModuleClass $class)

void addModule (ModuleItem $module)

void addVirtual (string $virtual, int $version, ModuleClass $class)

ModuleClass getClass (string $name)

ModuleItem getModule (string $id)

ModuleClass getVirtualClass (string $virtual, int $version)

ModuleItem getVirtualModule (string $virtual, int $version)

ModuleList getVirtualModules (string $virtual, int $version)

Methods

addClass (line 100)

Adds a class to the index

access: public

void addClass (string $name, ModuleClass $class)

string $name: Classname
ModuleClass $class: correpsonding ModuleClass object

addModule (line 67)

Adds a module to the index

access: public

void addModule (ModuleItem $module)

ModuleItem $module

addVirtual (line 126)

Adds a virtual role to the index

access: public

void addVirtual (string $virtual, int $version, ModuleClass $class)

string $virtual: Virtual role
int $version: Virtual role version
ModuleClass $class: Class implementing the role

getClass (line 111)

Gets a class by classname

access: public

ModuleClass getClass (string $name)

string $name: Classname

getModule (line 85)

Gets a module by its ID

access: public

ModuleItem getModule (string $id)

string $id: Module id

getVirtualClass (line 142)

Gets the first class implementing a virtual role

access: public

ModuleClass getVirtualClass (string $virtual, int $version)

string $virtual: Virtual role
int $version: Virtual role version

getVirtualModule (line 157)

Gets the module containing a class implementing a virtual role

access: public

ModuleItem getVirtualModule (string $virtual, int $version)

string $virtual: Virtual role
int $version: Virtual role version

getVirtualModules (line 172)

Gets all modules containing classes implementing a virtual

access: public

ModuleList getVirtualModules (string $virtual, int $version)

string $virtual: Virtual role
int $version: Virtual role version