FuzeWorks/Core
FuzeWorks
/
Core
1
0
Fork 0
Code Issues 9 Pull Requests Packages Releases Activity

Implemented module advertisements. 

A module advertises it has certain data, identified by a key. The moment a module gets loaded that listens for that key, it will get send this data.
Using this technique it is possible to load certain predefined data into modules, without loading the actual module. This data is prone to future caching as well.
This commit is contained in:
Abel Hoogeveen 2016-01-16 21:21:11 +01:00
parent c5eae9823c
commit a184d43c9e
3 changed files with 71 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Core/System/class.abstract.module.php
View File

@ -51,7 +51,7 @@ class Module {
protected $moduleName = 'placeholder';
/**
* @var String name used in the mod array
* @var String name used in the mod array
*/
protected $linkName = 'placeholder';
@ -60,6 +60,11 @@ class Module {
*/
protected $cfg;
/**
* @var array Advertisements send from other modules
*/
protected $advertisements = array();
/**
* Returns the name of the module
*
@ -152,6 +157,14 @@ class Module {
}
}
/**
* Set the advertisements send by other modules
* @param array $advertisements Advertisement data
*/
public function setAdvertisements($advertiseName, $advertiseData) {
$this->advertisements[$advertiseName] = $advertiseData;
}
/**
* Return a value from the module configuration
* @access public

62
Core/System/class.modules.php
View File

@ -45,7 +45,13 @@ class Modules {
* The module headers contain information required to loading the module
* @var Array
*/
public static $register;
private static $register;
/**
* A register which holds all the module advertisements by key
* @var array
*/
private static $advertiseRegister = array();
/**
* An array of all the loaded modules
@ -85,10 +91,8 @@ class Modules {
$cfg = (object) self::$register[$name];
// Check if the module is disabled
if (isset($cfg->meta)) {
throw new ModuleException("Requested mod '".$name."' could not be loaded. Not enabled", 1);
return false;
}
if (isset($cfg->meta))
throw new ModuleException("Could not load module. Module '".$name."' is not enabled", 1);
// Check if the module is already loaded. If so, only return a reference, if not, load the module
if (in_array($name, self::$loaded_modules)) {
@ -117,7 +121,7 @@ class Modules {
Logger::log($msg);
} else {
// Throw Exception if the file does not exist
throw new ModuleException("Requested mod '".$name."' could not be loaded. Class file not found", 1);
throw new ModuleException("Could not load module. Module '".$name."' class file was not found.", 1);
return false;
}
@ -134,15 +138,30 @@ class Modules {
$CLASS = new $class_name();
// Apply default methods
if (method_exists($CLASS, 'setModulePath')) {
if (method_exists($CLASS, 'setModulePath'))
$CLASS->setModulePath($cfg->directory);
}
if (method_exists($CLASS, 'setModuleLinkName')) {
if (method_exists($CLASS, 'setModuleLinkName'))
$CLASS->setModuleLinkName(strtolower($cfg->module_name));
}
if (method_exists($CLASS, 'setModuleName')) {
if (method_exists($CLASS, 'setModuleName'))
$CLASS->setModuleName($name);
// Send all advertisements
if (isset($cfg->listenFor)) {
$listenFor = $cfg->listenFor;
if (method_exists($CLASS, 'setAdvertisements')) {
foreach ($listenFor as $advertiseName) {
if (isset(self::$advertiseRegister[$advertiseName])) {
$CLASS->setAdvertisements($advertiseName, self::$advertiseRegister[$advertiseName]);
}
}
} else {
throw new ModuleException("Could not load module. Module '".$name."' listens for advertisement but does not implement setAdvertisements() method.", 1);
}
}
// Send the moduleConfig if possible
if (method_exists($CLASS, 'setModuleConfig')) {
// Append the config file to the module CFG (accessable through $this->cfg)
if (file_exists($cfg->directory . "/" . "config.".strtolower($cfg->module_name).".php")) {
@ -155,9 +174,10 @@ class Modules {
$CLASS->setModuleConfig($cfg);
}
if (!method_exists($CLASS, 'onLoad')) {
throw new ModuleException("Module '".$name."' does not have an onLoad() method! Invalid module", 1);
}
// And finally check if it can be loaded
if (!method_exists($CLASS, 'onLoad'))
throw new ModuleException("Could not load module. Module '".$name."' does not have an onLoad() method", 1);
$CLASS->onLoad();
// Add to the loaded modules
@ -167,7 +187,7 @@ class Modules {
return self::$modules[strtolower($cfg->module_name)] = &$CLASS;
}
} else {
throw new ModuleException("Invalid module found: '".$name."'", 1);
throw new ModuleException("Could not load module. Module '".$name."' has an invalid config", 1);
}
} else {
throw new ModuleException("Module not found: '".$name."'", 1);
@ -425,6 +445,18 @@ class Modules {
}
}
// And check for an advertisement tag
if (isset($cfg->advertise)) {
// Cycle through advertisements
foreach ($cfg->advertise as $advertiseName => $advertiseData) {
// Log advertisement
Logger::log('Advertisement added: \'' .$advertiseName. '\'');
// Add to advertiseRegister
self::$advertiseRegister[$advertiseName][$name] = $advertiseData;
}
}
Logger::stopLevel();
} else {

13
Modules/example/moduleInfo.php
View File

@ -51,11 +51,18 @@ return array(
// Events that this module listens for. When the exampleEvent is fired, this module will be loaded so the module can handle the event
'events' => array('exampleEvent'),
// Routes that this module listens on. If the URL /example/ gets called, this module will be loaded
// Everything after /example/ will be sent to the route() function in the matches array under the 'data' key
// A route must ALWAYS have the module capturing group. Otherwise it will fail
// Routes that this module listens on. Any URL that matches this pattern will load this module
// If the URL /example/ gets called, this module will be loaded
// Everything after /example/ will be sent to the route() function in the matches array under the, in this example, 'data' key
'routes' => array('/^example(|\/(?P<data>.*?))$/'),
// Advertises some data with the key 'exampleAdvertisement'. This data will be sent to a module which listens for this key.
// This allows for some data to be sent to a module which listens to this key.
'advertise' => array('exampleAdvertisement' => array('exampleData')),
// Tells the module engine that this module would like all the data with the key 'exampleAdvertisement'.
'listenFor' => array('exampleAdvertisement'),
// The name of the module as it will be logged. This does not affect usage of the module in any way
'name' => 'FuzeWorks Example Module',