Ben Roberts
81521eae5f
All framework classes have been renamed to use the SihnonFramework_ prefix. The class autoloader now looks for subclasses of the framework classes in the Sihnon_Lib directory, and automatically creates them if they don't exist. The autoloader correctly creates interfaces and abstract classes as needed, by using reflection to check the type of the parent class. All references to classes within the framework now use the Sihnon_ prefix. The PluginFactory supports multiple scan directories, and will search both the framework and subclass class tree to find candidate plugins.
90 lines
2.9 KiB
PHP
90 lines
2.9 KiB
PHP
<?php
|
|
|
|
abstract class SihnonFramework_PluginFactory implements Sihnon_IPluginFactory {
|
|
|
|
static private $validPlugins = array();
|
|
|
|
/**
|
|
* Scan the plugin directory for potential plugins, and load any valid ones found
|
|
*
|
|
* @param bool $force Rescan the plugin directory even if it has already been scanned before
|
|
*/
|
|
public static function scan($force = false) {
|
|
if ($force || ! isset(self::$validPlugins[get_called_class()])) {
|
|
$candidatePlugins = static::findPlugins(static::$plugin_dir);
|
|
|
|
static::loadPlugins($candidatePlugins, static::$plugin_prefix, static::$plugin_interface);
|
|
}
|
|
}
|
|
|
|
protected static function ensureScanned() {
|
|
if (! isset(self::$validPlugins[get_called_class()])) {
|
|
static::scan();
|
|
}
|
|
}
|
|
|
|
protected static function isValidPlugin($plugin) {
|
|
return isset(self::$validPlugins[get_called_class()][$plugin]);
|
|
}
|
|
|
|
public static function getValidPlugins() {
|
|
static::ensureScanned();
|
|
return array_keys(self::$validPlugins[get_called_class()]);
|
|
}
|
|
|
|
protected static function findPlugins($directories) {
|
|
$plugins = array();
|
|
|
|
if (! is_array($directories)) {
|
|
$directories = array(SihnonLib => $directories);
|
|
}
|
|
|
|
foreach ($directories as $base_dir => $directory) {
|
|
if (! file_exists($base_dir . $directory)) {
|
|
continue;
|
|
}
|
|
|
|
$iterator = new Sihnon_Utility_ClassFilesIterator(new Sihnon_Utility_VisibleFilesIterator(new DirectoryIterator($base_dir . $directory)));
|
|
|
|
foreach ($iterator as /** @var SplFileInfo */ $file) {
|
|
$plugin = preg_replace('/.class.php$/', '', $file->getFilename());
|
|
$plugins[] = $plugin;
|
|
}
|
|
}
|
|
|
|
return $plugins;
|
|
}
|
|
|
|
protected static function loadPlugins($plugins, $prefix, $interface) {
|
|
self::$validPlugins[get_called_class()] = array();
|
|
|
|
foreach ($plugins as $plugin) {
|
|
$fullClassname = $prefix . $plugin;
|
|
if ( ! class_exists($fullClassname, true)) {
|
|
continue;
|
|
}
|
|
|
|
if ( ! in_array($interface, class_implements($fullClassname))) {
|
|
continue;
|
|
}
|
|
|
|
// Initialise the plugin
|
|
call_user_func(array($fullClassname, 'init'));
|
|
|
|
self::$validPlugins[get_called_class()][$plugin] = $fullClassname;
|
|
}
|
|
}
|
|
|
|
public static function classname($plugin) {
|
|
static::ensureScanned();
|
|
|
|
if ( ! self::isValidPlugin($plugin)) {
|
|
throw new Sihnon_Exception_InvalidPluginName($plugin);
|
|
}
|
|
|
|
return self::$validPlugins[get_called_class()][$plugin];
|
|
}
|
|
|
|
}
|
|
|
|
?>
|