Updates framework to support automated framework subclasses
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.
This commit is contained in:
235
source/lib/SihnonFramework/Main.class.php
Normal file
235
source/lib/SihnonFramework/Main.class.php
Normal file
@@ -0,0 +1,235 @@
|
||||
<?php
|
||||
|
||||
class SihnonFramework_Main {
|
||||
|
||||
protected static $instance;
|
||||
|
||||
protected $config;
|
||||
protected $database;
|
||||
protected $log;
|
||||
protected $cache;
|
||||
|
||||
protected $base_uri;
|
||||
|
||||
protected function __construct() {
|
||||
$this->base_uri = dirname($_SERVER['SCRIPT_NAME']) . '/';
|
||||
}
|
||||
|
||||
protected function init() {
|
||||
if (Sihnon_DatabaseSupport) {
|
||||
$this->database = new Sihnon_Database(Sihnon_DBConfig);
|
||||
}
|
||||
|
||||
$this->config = new Sihnon_Config(Sihnon_ConfigPlugin, array(
|
||||
'database' => $this->database,
|
||||
'table' => Sihnon_ConfigTable,
|
||||
'filename' => Sihnon_ConfigFile)
|
||||
);
|
||||
|
||||
$this->log = new Sihnon_Log($this->config->get('logging.plugin'), array(
|
||||
'database' => $this->database)
|
||||
);
|
||||
|
||||
$this->cache = new Sihnon_Cache($this->config);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @return SihnonFramework_Main
|
||||
*/
|
||||
public static function instance() {
|
||||
if (!self::$instance) {
|
||||
self::$instance = new Sihnon_Main();
|
||||
self::$instance->init();
|
||||
}
|
||||
|
||||
return self::$instance;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @return SihnonFramework_Config
|
||||
*/
|
||||
public function config() {
|
||||
return $this->config;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @return SihnonFramework_Database
|
||||
*/
|
||||
public function database() {
|
||||
return $this->database;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @return SihnonFramework_Log
|
||||
*/
|
||||
public function log() {
|
||||
return $this->log;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @return SihnonFramework_Cache
|
||||
*/
|
||||
public function cache() {
|
||||
return $this->cache;
|
||||
}
|
||||
|
||||
public function baseUri() {
|
||||
return $this->base_uri;
|
||||
}
|
||||
|
||||
public function absoluteUrl($relative_url) {
|
||||
$secure = isset($_SERVER['secure']);
|
||||
$port = $_SERVER['SERVER_PORT'];
|
||||
return 'http' . ($secure ? 's' : '') . '://'
|
||||
. $_SERVER['HTTP_HOST'] . (($port == 80 || ($secure && $port == 443)) ? '' : ':' . $port)
|
||||
. '/' . $this->base_uri . $relative_url;
|
||||
}
|
||||
|
||||
public static function initialise() {
|
||||
spl_autoload_register(array('SihnonFramework_Main','autoload'));
|
||||
}
|
||||
|
||||
public static function autoload($classname) {
|
||||
// Ensure the classname contains only valid class name characters
|
||||
if (!preg_match('/^[A-Z][a-zA-Z0-9_]*$/', $classname)) {
|
||||
throw new Exception('Illegal characters in classname');
|
||||
}
|
||||
|
||||
// Ensure the class to load begins with our prefix
|
||||
if (preg_match('/^SihnonFramework_/', $classname)) {
|
||||
// Special case: all related exceptions are grouped into a single file
|
||||
if (preg_match('/^(Sihnon(?:Framework)?_(?:.*_))Exception/', $classname, $matches = array())) {
|
||||
require_once(Sihnon_Lib . preg_replace('/_/', '/', $matches[1]) . 'Exceptions.class.php');
|
||||
return;
|
||||
}
|
||||
|
||||
// Replace any underscores with directory separators
|
||||
$filename = SihnonFramework_Lib . preg_replace('/_/', '/', $classname) . '.class.php';
|
||||
|
||||
// If this file exists, load it
|
||||
if (file_exists($filename)) {
|
||||
require_once $filename;
|
||||
return;
|
||||
}
|
||||
} elseif (preg_match('/^Sihnon_/', $classname)) {
|
||||
// Sihnon_ classes subclass the SihnonFramework_ classes.
|
||||
// If a subclass doesn't exist, create it on the fly
|
||||
|
||||
// Special case: all related exceptions are grouped into a single file
|
||||
if (preg_match('/^(Sihnon(?:Framework)?_(?:.*_))Exception/', $classname, $matches = array())) {
|
||||
require_once(Sihnon_Lib . preg_replace('/_/', '/', $matches[1]) . 'Exceptions.class.php');
|
||||
return;
|
||||
}
|
||||
|
||||
// Replace any underscores with directory separators
|
||||
$filename = Sihnon_Lib . preg_replace('/_/', '/', $classname) . '.class.php';
|
||||
|
||||
// If this file exists, load it
|
||||
if (file_exists($filename)) {
|
||||
require_once $filename;
|
||||
return;
|
||||
} else {
|
||||
// Create this class to extend the Framework parent
|
||||
$parent_classname = preg_replace('/^Sihnon_/', 'SihnonFramework_', $classname);
|
||||
|
||||
// Determine if the classname represents a class or an interface
|
||||
$parent_class = new ReflectionClass($parent_classname);
|
||||
$class_definition = '';
|
||||
if ($parent_class->isFinal()) {
|
||||
// Final classes cannot be extended
|
||||
return;
|
||||
}
|
||||
if ($parent_class->isInterface()) {
|
||||
$class_definition .= 'interface ';
|
||||
} else {
|
||||
if ($parent_class->isAbstract()) {
|
||||
$class_definition .= 'abstract ';
|
||||
}
|
||||
|
||||
$class_definition .= 'class ';
|
||||
}
|
||||
$class_definition .= "{$classname} extends {$parent_classname} {};";
|
||||
|
||||
eval($class_definition);
|
||||
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Throws an exception if the requested name has not been defined.
|
||||
*
|
||||
* @param string $name Name of the definition to check for the existence of
|
||||
* @throws Sihnon_Exception_MissingDefinition
|
||||
*/
|
||||
public static function ensureDefined($name) {
|
||||
if (! defined($name)) {
|
||||
throw new Sihnon_Exception_MissingDefinition($name);
|
||||
}
|
||||
}
|
||||
|
||||
public static function mkdir_recursive($directory, $permissions=0777) {
|
||||
$parts = explode('/', $directory);
|
||||
$path = '';
|
||||
for ($i=1,$l=count($parts); $i<=$l; $i++) {
|
||||
$iPath = $parts;
|
||||
$path = join('/', array_slice($iPath, 0, $i));
|
||||
if (empty($path)) continue;
|
||||
if (!file_exists($path)) {
|
||||
if (!mkdir($path)) return false;
|
||||
if (!chmod($path, $permissions)) return false;
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
public static function issetelse($var, $default = null) {
|
||||
if (isset($var)) {
|
||||
return $var;
|
||||
}
|
||||
|
||||
if (is_string($default) && preg_match('/^Sihnon(Framework)?_Exception/', $default) && class_exists($default) && is_subclass_of($default, SihnonFramework_Exception)) {
|
||||
throw new $default();
|
||||
}
|
||||
|
||||
return $default;
|
||||
}
|
||||
|
||||
public static function formatDuration($time) {
|
||||
if (is_null($time)) {
|
||||
return 'unknown';
|
||||
}
|
||||
|
||||
$labels = array('seconds', 'minutes', 'hours', 'days', 'weeks', 'months', 'years');
|
||||
$limits = array(1, 60, 3600, 86400, 604800, 2592000, 31556926, PHP_INT_MAX);
|
||||
|
||||
$working_time = $time;
|
||||
|
||||
$result = "";
|
||||
$ptr = count($labels) - 1;
|
||||
|
||||
while ($ptr >= 0 && $working_time < $limits[$ptr]) {
|
||||
--$ptr;
|
||||
}
|
||||
|
||||
while ($ptr >= 0) {
|
||||
$unit_time = floor($working_time / $limits[$ptr]);
|
||||
$working_time -= $unit_time * $limits[$ptr];
|
||||
$result = $result . ' ' . $unit_time . ' ' . $labels[$ptr];
|
||||
--$ptr;
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
SihnonFramework_Main::initialise();
|
||||
|
||||
?>
|
||||
Reference in New Issue
Block a user