Jet\Application_Modules_Handler

Jak již bylo uvedeno, tak pro práci s moduly se sice používá třída Jet\Application_Modules, ale ta slouží pouze jako kontejner. Samotné provádění operací řeší handler (sám o sobě vlastně také modul), který je vždy potomkem abstraktní třídy Jet\Application_Modules_Handler. V Jet je jako výchozí handler třída Jet\Application_Modules_Handler_Default.

Seznam metod a jejich význam a chování je zcela identické s tím jak je popsáno u třídy Jet\Application_Modules (pouze metody nejsou statické).

Přehled metod

Metoda Význam
public getModuleDir(
string $module_name
): string		 Vrátí plnou cestu k adresáři modulu daného jména.
public allModulesList(
): Application_Module_Manifest[]		 Vrátí pole manifestů všech nalezených modulů, bez ohledu na to zda jsou nainstalované a aktivní.
public installedModulesList(
): Application_Module_Manifest[]		 Vrátí pole manifestů všech instalovaných modulů a to i když nejsou aktivní.
public activatedModulesList(
): Application_Module_Manifest[]		 Vrátí pole manifestů všech instalovaných a aktivovaných modulů.
public moduleExists(
string $module_name
): bool		 Indikuje zda modul vůbec existuje bez ohledu na to zda je nainstalovaný a aktivní.
public moduleIsInstalled(
string $module_name
): bool		 Indikuje zda je modul nainstalovaný bez ohledu na to zda je aktivní.
public moduleIsActivated(
string $module_name
): bool		 Indikuje zda je modul nainstalovaný a aktivní.
public moduleManifest(
string $module_name
): Application_Module_Manifest		 Vrátí manifest určitého modulu.

Pozor! Požadovaný modul musí existovat (ale nemusí být nainstalovaný a aktivní).
public installModule(
string $module_name
): void		 Nainstaluje modul a během instalace provede instalační skript (pokud existuje).

Pokud cokoliv selže, tak vyhazuje výjimku Jet\Application_Modules_Exception.
public uninstallModule(
string $module_name
): void		 Odinstaluje modul a během deinstalace provede deinstalační skript (pokud existuje).

Pokud cokoliv selže, tak vyhazuje výjimku Jet\Application_Modules_Exception.
public activateModule(
string $module_name
): void		 Aktivuje modul.

Pokud cokoliv selže, tak vyhazuje výjimku Jet\Application_Modules_Exception.
public deactivateModule(
string $module_name
): void		 Deaktivuje modul.

Pokud cokoliv selže, tak vyhazuje výjimku Jet\Application_Modules_Exception.
public moduleInstance(
string $module_name
): Application_Module		 Vrátí instanci hlavní třídy Main požadovaného modulu.

Modul musí být aktivní. Pokud není, pak je vyhozena výjimka Jet\Application_Modules_Exception.

K tomu by nemělo v aplikaci dojít. Před prací s modulem je vhodné ověřit jeho dostupnost a dle toho řešit aplikační logiku. Nebo by modul měl být mandatorní a mělo by být zajištěno, že jej nikdo nedeaktivuje.
public readManifestData(
string $module_name
): void		 Ze souboru manifestu načte surová data.
public saveManifest(
Application_Module_Manifest $manifest
): void		 Zapíše data manifestu do souboru.
Předchozí kapitola
Jet\Application_Modules
Další kapitola
Manifest modul - Jet\Application_Module_Manifest
GitHub