Docs For Class ModuleOverlay

Class ModuleOverlay

Description

Implements interfaces:

Representation of a single module overlay

Provides an iterator (through the contained ModuleList). Error handling is done using ModuleException exceptions.

uses: CacheManager

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

Method Summary

ModuleOverlay __construct (string $path)

void append (ModuleOverlay $new)

ModuleItem findModule (ModuleSearch $search)

ModuleList findModules (ModuleSearch $search, [ModuleList $results = null])

ModuleList getIterator ()

string getPath ()

ModuleOverlay last ()

ModuleOverlay next ()

Methods

Constructor __construct (line 70)

Initializes a new Overlay by path

Builds a list of modules in this overlay. Needs to be cached.

access: public
uses: buildList()

ModuleOverlay __construct (string $path)

string $path: Path to overlay

append (line 147)

Appends/inserts a overlay after this one

Works when there is an successor.

access: public

void append (ModuleOverlay $new)

ModuleOverlay $new: Overlay to add

findModule (line 174)

Recursivly searches for a module

Also searches in succeeding overlays. Returns when the first match is found.

access: public
see: ModuleSearch

ModuleItem findModule (ModuleSearch $search)

ModuleSearch $search: Search criteria

findModules (line 199)

Finds all modules matching the search criteria

Searches in this and all succeeding overlays.

access: public
see: ModuleSearch

ModuleList findModules (ModuleSearch $search, [ModuleList $results = null])

ModuleSearch $search: Search criteria
ModuleList $results: Result list

getIterator (line 220)

Provides an iterator.

This function allows (through the IteratorAggregate interface) easy walking over the contained modules.

access: public

ModuleList getIterator ()

getPath (line 114)

Gets the path to the overlay

access: public

string getPath ()

last (line 132)

Returns the last element in the list

access: public

ModuleOverlay last ()

next (line 123)

Returns the next overlay in the list

access: public

ModuleOverlay next ()

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