X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fclass_BaseFrameworkSystem.php;h=b8f63065bd255fe25e12d19d4f098fcadf0ae31c;hb=5e89637b5069092a60b8a6c38b670bf0cf7aa4fd;hp=d548e58433fc0a62a4a408b792aa234d3eb79a92;hpb=08b1d39fa38b86cca6a0a6c968162d30ca171ae5;p=core.git diff --git a/inc/classes/main/class_BaseFrameworkSystem.php b/inc/classes/main/class_BaseFrameworkSystem.php index d548e584..b8f63065 100644 --- a/inc/classes/main/class_BaseFrameworkSystem.php +++ b/inc/classes/main/class_BaseFrameworkSystem.php @@ -5,7 +5,7 @@ * * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team * @license GNU GPL 3.0 or any newer version * @link http://www.ship-simu.org * @@ -23,21 +23,6 @@ * along with this program. If not, see . */ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { - /** - * Instance to an application helper class - */ - private static $applicationInstance = null; - - /** - * The language instance for the template loader - */ - private static $langInstance = null; - - /** - * Debug instance - */ - private static $debugInstance = null; - /** * Instance of a request class */ @@ -91,17 +76,17 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { /** * The real class name */ - private $realClass = "FrameworkSystem"; + private $realClass = 'FrameworkSystem'; /** * Thousands seperator */ - private $thousands = "."; // German + private $thousands = '.'; // German /** * Decimal seperator */ - private $decimals = ","; // German + private $decimals = ','; // German /*********************** * Exception codes.... * @@ -164,6 +149,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { const EXCEPTION_ASSERTION_FAILED = 0x037; const EXCEPTION_FILE_CANNOT_BE_READ = 0x038; const EXCEPTION_DATABASE_UPDATED_NOT_ALLOWED = 0x039; + const EXCEPTION_FILTER_CHAIN_INTERCEPTED = 0x040; /** * In the super constructor these system classes shall be ignored or else @@ -175,25 +161,21 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { *---------------------------------------------------------------------* */ private $systemClasses = array( - "DebugMiddleware", // Debug middleware output sub-system - "Registry", // Object registry - "ObjectFactory", // Object factory - "DebugWebOutput", // Debug web output sub-system - "WebOutput", // Web output sub-system - "CompressorChannel", // Compressor sub-system - "DebugConsoleOutput", // Debug console output sub-system - "DebugErrorLogOutput", // Debug error_log() output sub-system - "FrameworkDirectoryPointer", // Directory handler sub-system - "NullCompressor", // Null compressor - "Bzip2Compressor", // BZIP2 compressor - "GzipCompressor", // GZIP compressor + 'DebugMiddleware', // Debug middleware output sub-system + 'Registry', // Object registry + 'ObjectFactory', // Object factory + 'DebugWebOutput', // Debug web output sub-system + 'WebOutput', // Web output sub-system + 'CompressorChannel', // Compressor sub-system + 'DebugConsoleOutput', // Debug console output sub-system + 'DebugErrorLogOutput', // Debug error_log() output sub-system + 'FrameworkDirectoryPointer', // Directory handler sub-system + 'NullCompressor', // Null compressor + 'Bzip2Compressor', // BZIP2 compressor + 'GzipCompressor', // GZIP compressor ); - - /* No longer used: - */ - /** - * Private super constructor + * Protected super constructor * * @param $className Name of the class * @return void @@ -226,7 +208,8 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) { // Already destructed object $this->debugOutput(sprintf("[%s:] The object %s is already destroyed.", - __CLASS__, $this->__toString() + __CLASS__, + $this->__toString() )); } } @@ -238,30 +221,30 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { */ public final function __call ($methodName, $args) { // Implode all given arguments - $argsString = ""; + $argsString = ''; if (empty($args)) { // No arguments - $argsString = "NULL"; + $argsString = 'NULL'; } elseif (is_array($args)) { // Some arguments are there foreach ($args as $arg) { // Add the type - $argsString .= $arg." (".gettype($arg); + $argsString .= $arg . ' (' . gettype($arg); // Add length if type is string - if (gettype($arg) == 'string') $argsString .= ", ".strlen($arg); + if (gettype($arg) == 'string') $argsString .= ', '.strlen($arg); // Closing bracket - $argsString .= "), "; + $argsString .= '), '; } // END - foreach // Remove last comma - if (substr($argsString, -2, 1) === ",") { + if (substr($argsString, -2, 1) == ',') { $argsString = substr($argsString, 0, -2); } // END - if } else { // Invalid arguments! - $argsString = sprintf("!INVALID:%s!", $args); + $argsString = '!INVALID:' . gettype($args) . '!'; } // Output stub message @@ -293,14 +276,14 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { $this->setDebugInstance(DebugMiddleware::createDebugMiddleware($this->getConfigInstance()->readConfig('debug_class'))); // Get output instance and set it - $outputInstance = ObjectFactory::createObjectByConfiguredName('web_engine', array($this->getConfigInstance()->readConfig('web_content_type'))); + $outputInstance = ObjectFactory::createObjectByConfiguredName('output_class', array($this->getConfigInstance()->readConfig('web_content_type'))); $this->setWebOutputInstance($outputInstance); // Set the compressor channel - $this->setCompressorChannel(CompressorChannel::createCompressorChannel(sprintf("%s%s", - $this->getConfigInstance()->readConfig('base_path'), + $this->setCompressorChannel(CompressorChannel::createCompressorChannel( + $this->getConfigInstance()->readConfig('base_path'). $this->getConfigInstance()->readConfig('compressor_base_path') - ))); + )); // Initialization done! :D Registry::isInitialized('OK'); @@ -420,11 +403,11 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { /** * Getter for configuration instance * - * @return $cfgInstance Configuration instance + * @return $configInstance Configuration instance */ public final function getConfigInstance () { - $cfgInstance = Registry::getRegistry()->getInstance('config'); - return $cfgInstance; + $configInstance = Registry::getRegistry()->getInstance('config'); + return $configInstance; } /** @@ -434,7 +417,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * @return void */ public final function setDebugInstance (DebugMiddleware $debugInstance) { - self::$debugInstance = $debugInstance; + Registry::getRegistry()->addInstance('debug', $debugInstance); } /** @@ -443,7 +426,8 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * @return $debugInstance Instance to class DebugConsoleOutput or DebugWebOutput */ public final function getDebugInstance () { - return self::$debugInstance; + $debugInstance = Registry::getRegistry()->getInstance('debug'); + return $debugInstance; } /** @@ -459,10 +443,11 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { /** * Getter for web output instance * - * @return $webOutput - Instance to class WebOutput + * @return $webOutputInstance - Instance to class WebOutput */ public final function getWebOutputInstance () { - return Registry::getRegistry()->getInstance('web_output'); + $webOutputInstance = Registry::getRegistry()->getInstance('web_output'); + return $webOutputInstance; } /** @@ -473,7 +458,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * @return void */ public final function setDatabaseInstance (DatabaseConnection $dbInstance) { - Registry::getRegistry()->addInstance('dbInstance', $dbInstance); + Registry::getRegistry()->addInstance('db_instance', $dbInstance); } /** @@ -487,7 +472,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { // Is the registry there and initialized? if ((class_exists('Registry')) && (Registry::isInitialized() === true)) { - $dbInstance = Registry::getRegistry()->getInstance('dbInstance'); + $dbInstance = Registry::getRegistry()->getInstance('db_instance'); } // END - if // Return instance @@ -497,20 +482,21 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { /** * Setter for compressor channel * - * @param $compressorChannel An instance of CompressorChannel + * @param $compressorInstance An instance of CompressorChannel * @return void */ - public final function setCompressorChannel (CompressorChannel $compressorChannel) { - Registry::getRegistry()->addInstance('compressor', $compressorChannel); + public final function setCompressorChannel (CompressorChannel $compressorInstance) { + Registry::getRegistry()->addInstance('compressor', $compressorInstance); } /** * Getter for compressor channel * - * @return $compressor The compressor channel + * @return $compressorInstance The compressor channel */ public final function getCompressorChannel () { - return Registry::getRegistry()->getInstance('compressor'); + $compressorInstance = Registry::getRegistry()->getInstance('compressor'); + return $compressorInstance; } /** @@ -519,7 +505,8 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * @return $applicationInstance An instance of a manageable application helper class */ protected final function getApplicationInstance () { - return self::$applicationInstance; + $applicationInstance = Registry::getRegistry()->getInstance('application'); + return $applicationInstance; } /** @@ -529,7 +516,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * @return void */ public final function setApplicationInstance (ManageableApplication $applicationInstance) { - self::$applicationInstance = $applicationInstance; + Registry::getRegistry()->addInstance('application', $applicationInstance); } /** @@ -636,7 +623,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * thousands seperator * is missing */ - public function formatCurrency ($value, $currency = "€", $decNum = 2) { + public function formatCurrency ($value, $currency = '€', $decNum = 2) { // Are all required attriutes set? if ((!isset($this->decimals)) || (!isset($this->thousands))) { // Throw an exception @@ -647,10 +634,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { $value = (float) $value; // Reformat the US number - $price = sprintf("%s %s", - number_format($value, $decNum, $this->decimals, $this->thousands), - $currency - ); + $price = number_format($value, $decNum, $this->decimals, $this->thousands) . $currency; // Return as string... return $price; @@ -672,7 +656,8 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * @return $langInstance An instance to the language sub-system */ protected final function getLanguageInstance () { - return self::$langInstance; + $langInstance = Registry::getRegistry()->getInstance('language'); + return $langInstance; } /** @@ -683,7 +668,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * @see LanguageSystem */ public final function setLanguageInstance (ManageableLanguage $langInstance) { - self::$langInstance = $langInstance; + Registry::getRegistry()->addInstance('language', $langInstance); } /** @@ -703,7 +688,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { */ public final function addMissingTrailingSlash ($str) { // Is there a trailing slash? - if (substr($str, -1, 1) != "/") $str .= "/"; + if (substr($str, -1, 1) != '/') $str .= '/'; return $str; } @@ -755,13 +740,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { } // END - if } // END - if - // Generate FQFN for all application templates - $fqfn = sprintf("%s%s/%s", - $this->getConfigInstance()->readConfig('application_path'), - strtolower($appInstance->getAppShortName()), - $this->getConfigInstance()->readConfig('tpl_base_path') - ); - // Are both instances set? if ($appInstance->getLanguageInstance() === null) { // Invalid language instance @@ -772,7 +750,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { } // Initialize the template engine - $templateInstance = ObjectFactory::createObjectByConfiguredName('template_class', array($fqfn, $appInstance->getLanguageInstance(), $appInstance->getFileIoInstance())); + $templateInstance = ObjectFactory::createObjectByConfiguredName('template_class', array($appInstance)); // Return the prepared instance return $templateInstance; @@ -784,12 +762,12 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * @param $message Optional message to show in debug output * @return void */ - public final function debugInstance ($message = "") { + public final function debugInstance ($message = '') { // Restore the error handler to avoid trouble with missing array elements or undeclared variables restore_error_handler(); // Init content - $content = ""; + $content = ''; // Is a message set? if (!empty($message)) { @@ -820,12 +798,12 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * @param $message An optional message to display * @return void */ - protected function partialStub ($message = "") { + protected function partialStub ($message = '') { // Get the backtrace $backtrace = debug_backtrace(); // Generate the class::method string - $methodName = "UnknownClass->unknownMethod"; + $methodName = 'UnknownClass->unknownMethod'; if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) { $methodName = $backtrace[1]['class']."->".$backtrace[1]['function']; } // END - if @@ -899,13 +877,13 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { */ public function convertToClassName ($str) { // Init class name - $className = ""; + $className = ''; // Convert all dashes in underscores - $str = str_replace("-", "_", $str); + $str = $this->convertDashesToUnderscores($str); // Now use that underscores to get classname parts for hungarian style - foreach (explode("_", $str) as $strPart) { + foreach (explode('_', $str) as $strPart) { // Make the class name part lower case and first upper case $className .= ucfirst(strtolower($strPart)); } // END - foreach @@ -914,6 +892,20 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { return $className; } + /** + * Converts dashes to underscores, e.g. useable for configuration entries + * + * @param $str The string with maybe dashes inside + * @return $str The converted string with no dashed, but underscores + */ + public final function convertDashesToUnderscores ($str) { + // Convert them all + $str = str_replace('-', '_', $str); + + // Return converted string + return $str; + } + /** * Marks up the code by adding e.g. line numbers * @@ -922,7 +914,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { */ public function markupCode ($phpCode) { // Init marked code - $markedCode = ""; + $markedCode = ''; // Get last error $errorArray = error_get_last(); @@ -961,7 +953,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { */ public function doFilterFormatTimestamp ($timestamp) { // Default value to return - $readable = "???"; + $readable = '???'; // Is the timestamp null? if (is_null($timestamp)) { @@ -971,9 +963,9 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { switch ($this->getLanguageInstance()->getLanguageCode()) { case "de": // German format is a bit different to default // Split the GMT stamp up - $dateTime = explode(" ", $timestamp); - $dateArray = explode("-", $dateTime[0]); - $timeArray = explode(":", $dateTime[1]); + $dateTime = explode(' ', $timestamp ); + $dateArray = explode('-', $dateTime[0]); + $timeArray = explode(':', $dateTime[1]); // Construct the timestamp $readable = sprintf($this->getConfigInstance()->readConfig('german_date_time'), @@ -1120,6 +1112,30 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { $wrapperInstance->doUpdateByResult($this->getResultInstance()); } // END - if } + + /** + * Outputs a deprecation warning to the developer. + * + * @param $message The message we shall output to the developer + * @return void + * @todo Write a logging mechanism for productive mode + */ + public function deprecationWarning ($message) { + // Is developer mode active? + if (defined('DEVELOPER')) { + // Debug instance is there? + if (!is_null($this->getDebugInstance())) { + // Output stub message + $this->debugOutput($message); + } else { + // Trigger an error + trigger_error($message."
\n"); + } + } else { + // @TODO Finish this part! + $this->partialStub('Developer mode inactive. Message:' . $message); + } + } } // [EOF]