Docs For Class ModuleClass

Description

The objective representation of a class

Contains the data (name, file, provides) of a single class. Please note that depencies are defined per class but are stored and resolved per module.

Error handling is done using ModuleException exceptions.

see: ModuleItem

Located in /phpsatk-lib/core/15.module.class.php (line 41)

Method Summary

ModuleClass __construct (ModuleItem $module, string $name, string $file)

void addProvide (string $name, int $version)

string getFile ()

ModuleItem getModule ()

string getName ()

string getPath ()

array[string=>array[string=>int]] getProvides ()

ReflectionClass getReflection ()

boolean provides (string $name, integer $version)

Methods

Constructor __construct (line 90)

Initializes the class sturcture

access: public

ModuleClass __construct (ModuleItem $module, string $name, string $file)

ModuleItem $module: Module this class belongs to
string $name: Classname
string $file: File where this class is stored

addProvide (line 149)

Adds a virtual role to this class

access: public

void addProvide (string $name, int $version)

string $name: Virtual role
int $version: Virtual role version

getFile (line 129)

Gets the filename of the class' file

access: public

string getFile ()

getModule (line 110)

Gets the ModuleItem which contains this class

access: public

ModuleItem getModule ()

getName (line 120)

Gets the classname of this class

access: public

string getName ()

getPath (line 138)

Gets the full path to the classfile

access: public

string getPath ()

getProvides (line 173)

Gets an array of roles this module provides

access: public

array[string=>array[string=>int]] getProvides ()

getReflection (line 182)

Fetches a class reflector for this class

access: public

ReflectionClass getReflection ()

provides (line 160)

Checks whether this module provides a specified virtual module

access: public

boolean provides (string $name, integer $version)

string $name: Virtual module
integer $version: Virtual module version