*/
class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
/**
- * The instance to the debug output handler (should be DebugConsoleOutput or DebugWebOutput)
- *
- * @see DebugConsoleOutput
- * @see DebugWebOutput
+ * Instance to an application helper class
*/
- private static $debug = null;
+ private static $applicationInstance = null;
/**
- * The instance to the web output handler (should be WebOutput)
- *
- * @see WebOutput
+ * The language instance for the template loader
*/
- private static $webOutput = null;
+ private static $langInstance = null;
/**
- * The instance to the compression layer which should be CompressorChannel
+ * Debug instance
*/
- private static $compressor = null;
+ private static $debugInstance = null;
/**
- * The configuration instance which shall be FrameworkConfiguration
+ * Instance of a request class
*/
- private static $cfgInstance = null;
+ private $requestInstance = null;
/**
- * The instance to the database layer which should be DatabaseConnection
+ * Instance of a response class
*/
- private $dbInstance = null;
+ private $responseInstance = null;
/**
- * Instance to an application helper class
+ * Search criteria instance
+ */
+ private $searchInstance = null;
+
+ /**
+ * The file I/O instance for the template loader
+ */
+ private $fileIoInstance = null;
+
+ /**
+ * Resolver instance
+ */
+ private $resolverInstance = null;
+
+ /**
+ * Template engine instance
*/
- private $applicationInstance = null;
+ private $templateInstance = null;
/**
* The real class name
*/
private $decimals = ","; // German
- /**
- * The language instance for the template loader
- */
- private $langInstance = null;
-
- /**
- * The file I/O instance for the template loader
- */
- private $fileIOInstance = null;
-
/***********************
* Exception codes.... *
***********************/
const EXCEPTION_MISSING_LANGUAGE_HANDLER = 0x02e;
const EXCEPTION_MISSING_FILE_IO_HANDLER = 0x02f;
const EXCEPTION_MISSING_ELEMENT = 0x030;
- const EXCEPTION_INVALID_COMMAND = 0x031;
- const EXCEPTION_INVALID_CONTROLLER = 0x032;
- const EXCEPTION_HEADERS_ALREADY_SENT = 0x033;
- const EXCEPTION_DEFAUL_CONTROLLER_GONE = 0x034;
- const EXCEPTION_CLASS_NOT_FOUND = 0x035;
- const EXCEPTION_REQUIRED_INTERFACE_MISSING = 0x036;
+ const EXCEPTION_HEADERS_ALREADY_SENT = 0x031;
+ const EXCEPTION_DEFAULT_CONTROLLER_GONE = 0x032;
+ const EXCEPTION_CLASS_NOT_FOUND = 0x033;
+ const EXCEPTION_REQUIRED_INTERFACE_MISSING = 0x034;
+ const EXCEPTION_FATAL_ERROR = 0x035;
+ const EXCEPTION_FILE_NOT_FOUND = 0x036;
+ const EXCEPTION_ASSERTION_FAILED = 0x037;
+ const EXCEPTION_FILE_CANNOT_BE_READ = 0x038;
/**
* In the super constructor these system classes shall be ignored or else
*/
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
- "CompressorChannel", // Compressor sub-system
"FrameworkDirectoryPointer", // Directory handler sub-system
"NullCompressor", // Null compressor
"Bzip2Compressor", // BZIP2 compressor
"GzipCompressor", // GZIP compressor
- "WebOutput", // Web output sub-system
);
+ /* No longer used:
+ */
+
/**
* Private super constructor
*
+ * @param $className Name of the class
* @return void
*/
- protected function __construct ($class) {
+ protected function __construct ($className) {
// Set real class
- $this->setRealClass($class);
+ $this->setRealClass($className);
- // Init this instance
- $this->initInstance($class);
+ // Initialize the class if the registry is there
+ if ((class_exists('Registry')) && (Registry::isInitialized() === false)) {
+ $this->initInstance();
+ } // END - if
}
/**
if ($this->__toString() != "DestructedObject") {
// Debug message
if ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
- $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wird zerstört.<br />\n",
+ $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wird zerstört.",
__CLASS__, $this->__toString()
));
- }
+ } // END - if
// Destroy all informations about this class but keep some text about it alive
$this->setObjectDescription(sprintf("Entferntes Objekt <em>%s</em>", $this->__toString()));
$this->resetUniqueID();
} elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
// Already destructed object
- $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wurde bereits zerstört.<br />\n",
+ $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wurde bereits zerstört.",
__CLASS__, $this->__toString()
));
}
} elseif (is_null($arg)) {
// Null
$argsString .= "(null)";
+ } elseif (is_resource($arg)) {
+ // Resource
+ $argsString .= "(resource)";
} else {
// Unknown type (please report!)
- $argsString .= $arg."(unknown!)";
+ $argsString .= $arg."(<em>unknown!</em>)";
}
// Add comma
}
// Remove last comma
- if (substr($argsString, -2, 1) === ",") $argsString = substr($argsString, 0, -2);
+ if (substr($argsString, -2, 1) === ",") {
+ $argsString = substr($argsString, 0, -2);
+ } // END - if
} else {
// Invalid arguments!
$argsString = sprintf("!INVALID:%s!", $args);
}
- $this->getDebugInstance()->output(sprintf("[%s::%s] Stub! Args: %s",
+ // Output stub message
+ $this->getDebugInstance()->output(sprintf("[%s->%s] Stub! Args: %s",
$this->__toString(),
$methodName,
$argsString
}
/**
- * Initializes the instance
+ * Private initializer for this class
*
* @return void
*/
- public function initInstance ($class) {
- // Get the current (singleton) configuration instance
- $this->setConfigInstance(FrameworkConfiguration::createFrameworkConfiguration());
+ private final function initInstance () {
+ // Is this a system class?
+ if (!in_array($this->__toString(), $this->systemClasses)) {
+ // Add application helper to our class
+ $this->systemclasses[] = $this->getConfigInstance()->readConfig('app_helper_class');
+
+ // Set debug instance
+ $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')));
+ $this->setWebOutputInstance($outputInstance);
+
+ // Set the compressor channel
+ $this->setCompressorChannel(CompressorChannel::createCompressorChannel(sprintf("%s%s",
+ PATH,
+ $this->getConfigInstance()->readConfig('compressor_base_path')
+ )));
+
+ // Initialization done! :D
+ Registry::isInitialized("OK");
+ } elseif ($this->__toString() == "DebugMiddleware") {
+ // Set configuration instance
+ $this->setConfigInstance(FrameworkConfiguration::createFrameworkConfiguration());
+ }
+ }
- // Is the class weather debug nor compressor channel?
- if (!in_array($class, $this->systemClasses)) {
- // Initialize debug instance
- if (is_null($this->getDebugInstance())) {
- // Set the debug output system if it is not debug class ;)
- $this->setDebugInstance(DebugMiddleware::createDebugMiddleware($this->getConfigInstance()->readConfig('debug_engine')));
- } // END - if
+ /**
+ * Setter for template engine instances
+ *
+ * @param $templateInstance An instance of a template engine class
+ * @return void
+ */
+ protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
+ $this->templateInstance = $templateInstance;
+ }
- // Initialize web instance
- if ((is_null($this->getWebOutputInstance())) && ($this->__toString() != "ObjectFactory")) {
- // Call our object factory
- $outputInstance = ObjectFactory::createObjectByConfiguredName('web_engine', array($this->getConfigInstance()->readConfig('web_content_type')));
+ /**
+ * Getter for template engine instances
+ *
+ * @return $templateInstance An instance of a template engine class
+ */
+ protected final function getTemplateInstance () {
+ return $this->templateInstance;
+ }
- // And set the instance
- $this->setWebOutputInstance($outputInstance);
- } // END - if
+ /**
+ * Setter for search instance
+ *
+ * @param $searchInstance Searchable criteria instance
+ * @return void
+ */
+ public final function setSearchInstance (LocalSearchCriteria $searchInstance) {
+ $this->searchInstance = $searchInstance;
+ }
- // Initialize compressor channel
- if (is_null($this->getCompressorChannel())) {
- // Set the compressor channel
- $this->setCompressorChannel(CompressorChannel::createCompressorChannel(sprintf("%s%s",
- PATH,
- $this->getConfigInstance()->readConfig('compressor_base_path')
- )));
- } // END - if
+ /**
+ * Getter for search instance
+ *
+ * @return $searchInstance Searchable criteria instance
+ */
+ public final function getSearchInstance () {
+ return $this->searchInstance;
+ }
- // Initialize database middleware
- if (is_null($this->getDatabaseInstance())) {
- // Get the middleware instance
- $db = DatabaseConnection::getInstance();
- if (is_object($db)) {
- // Set the database middleware
- $this->setDatabaseInstance($db);
- } // END - if
- } // END - if
- } // END - if
+ /**
+ * Setter for resolver instance
+ *
+ * @param $resolverInstance Instance of a command resolver class
+ * @return void
+ */
+ public final function setResolverInstance (Resolver $resolverInstance) {
+ $this->resolverInstance = $resolverInstance;
+ }
+
+ /**
+ * Getter for resolver instance
+ *
+ * @return $resolverInstance Instance of a command resolver class
+ */
+ public final function getResolverInstance () {
+ return $this->resolverInstance;
}
/**
* @return void
*/
public final function setConfigInstance (FrameworkConfiguration $configInstance) {
- self::$cfgInstance = $configInstance;
+ Registry::getRegistry()->addInstance('config', $configInstance);
}
/**
* Getter for configuration instance
*
- * @return $cfhInstance - Configuration instance
+ * @return $cfgInstance Configuration instance
*/
- protected final function getConfigInstance () {
- return self::$cfgInstance;
+ public final function getConfigInstance () {
+ $cfgInstance = Registry::getRegistry()->getInstance('config');
+ return $cfgInstance;
}
/**
* Setter for debug instance
*
- * @param $debugInstance The instance for debug output class
+ * @param $debugInstance The instance for debug output class
* @return void
*/
public final function setDebugInstance (DebugMiddleware $debugInstance) {
- self::$debug = $debugInstance;
+ self::$debugInstance = $debugInstance;
}
/**
* Getter for debug instance
*
- * @return $debug - Instance to class DebugConsoleOutput or DebugWebOutput
+ * @return $debugInstance Instance to class DebugConsoleOutput or DebugWebOutput
*/
public final function getDebugInstance () {
- return self::$debug;
+ return self::$debugInstance;
}
/**
* @return void
*/
public final function setWebOutputInstance (OutputStreamer $webInstance) {
- self::$webOutput = $webInstance;
+ Registry::getRegistry()->addInstance('web_output', $webInstance);
}
/**
* @return $webOutput - Instance to class WebOutput
*/
public final function getWebOutputInstance () {
- return self::$webOutput;
+ return Registry::getRegistry()->getInstance('web_output');
}
/**
- * Static setter for database instance
+ * Setter for database instance
*
* @param $dbInstance The instance for the database connection
* (forced DatabaseConnection)
* @return void
*/
public final function setDatabaseInstance (DatabaseConnection $dbInstance) {
- $this->dbInstance = $dbInstance;
+ Registry::getRegistry()->addInstance('dbInstance', $dbInstance);
+ }
+
+ /**
+ * Getter for database layer
+ *
+ * @return $dbInstance The database layer instance
+ */
+ public final function getDatabaseInstance () {
+ if ((class_exists('Registry')) && (Registry::isInitialized() === true)) {
+ return Registry::getRegistry()->getInstance('dbInstance');
+ } else {
+ return null;
+ }
+ }
+
+ /**
+ * Setter for compressor channel
+ *
+ * @param $compressorChannel An instance of CompressorChannel
+ * @return void
+ */
+ public final function setCompressorChannel (CompressorChannel $compressorChannel) {
+ Registry::getRegistry()->addInstance('compressor', $compressorChannel);
+ }
+
+ /**
+ * Getter for compressor channel
+ *
+ * @return $compressor The compressor channel
+ */
+ public final function getCompressorChannel () {
+ return Registry::getRegistry()->getInstance('compressor');
+ }
+
+ /**
+ * Protected getter for a manageable application helper class
+ *
+ * @return $applicationInstance An instance of a manageable application helper class
+ */
+ protected final function getApplicationInstance () {
+ return self::$applicationInstance;
+ }
+
+ /**
+ * Setter for a manageable application helper class
+ *
+ * @param $applicationInstance An instance of a manageable application helper class
+ * @return void
+ */
+ public final function setApplicationInstance (ManageableApplication $applicationInstance) {
+ self::$applicationInstance = $applicationInstance;
+ }
+
+ /**
+ * Setter for request instance
+ *
+ * @param $requestInstance An instance of a Requestable class
+ * @return void
+ */
+ public final function setRequestInstance (Requestable $requestInstance) {
+ $this->requestInstance = $requestInstance;
+ }
+
+ /**
+ * Getter for request instance
+ *
+ * @return $requestInstance An instance of a Requestable class
+ */
+ public final function getRequestInstance () {
+ return $this->requestInstance;
+ }
+
+ /**
+ * Setter for response instance
+ *
+ * @param $responseInstance An instance of a Responseable class
+ * @return void
+ */
+ public final function setResponseInstance (Responseable $responseInstance) {
+ $this->responseInstance = $responseInstance;
+ }
+
+ /**
+ * Getter for response instance
+ *
+ * @return $responseInstance An instance of a Responseable class
+ */
+ public final function getResponseInstance () {
+ return $this->responseInstance;
}
/**
* @return void
*/
public final function generateUniqueId () {
- // Existiert noch keine?
+ // Is the id set for this class?
if (empty($this->uniqueID)) {
// Correct missing class name
$corrected = true;
}
- // Neue ID erstellen
+ // Cache datbase instance
+ $db = $this->getDatabaseInstance();
+
+ // Generate new id
$tempID = false;
while (true) {
// Generate a unique ID number
// Try to figure out if the ID number is not yet used
try {
- if (is_object($this->getDatabaseInstance())) {
- $isUsed = $this->getDatabaseInstance()->isUniqueIdUsed($tempID, true);
+ // Is this a registry?
+ if ($this->__toString() == "Registry") {
+ // Registry, then abort here
+ break;
+ } elseif (is_object($db)) {
+ $isUsed = $db->isUniqueIdUsed($tempID, true);
}
} catch (FrameworkException $e) {
// Catches all and ignores all ;-)
$tempID !== false
) && (
(
- $this->getDatabaseInstance() === null
+ $db === null
) || (
(
- is_object($this->getDatabaseInstance())
+ is_object($db)
) && (
!$isUsed
)
/**
* Validate if given object is the same as current
*
- * @param $object An object instance for comparison with this class
+ * @param $object An object instance for comparison with this class
* @return boolean The result of comparing both's unique ID
*/
- public final function equals ($object) {
+ public final function equals (FrameworkInterface $object) {
return ($this->getUniqueID() == $object->getUniqueID());
}
* Compare if both simulation part description and class name matches
* (shall be enougth)
*
- * @param $itemInstance An object instance to an other class
- * @return boolean The result of comparing class name simulation part description
+ * @param $itemInstance An object instance to an other class
+ * @return boolean The result of comparing class name simulation part description
*/
public function itemMatches ($itemInstance) {
return (
/**
* Compare class name of this and given class name
*
- * @param $class The class name as string from the other class
+ * @param $className The class name as string from the other class
* @return boolean The result of comparing both class names
*/
- public final function isClass ($class) {
- return ($this->__toString() == $class);
+ public final function isClass ($className) {
+ return ($this->__toString() == $className);
}
/**
}
/**
- * Getter for database layer
+ * Private getter for language instance
*
- * @return $dbInstance The database layer instance
+ * @return $langInstance An instance to the language sub-system
*/
- public final function getDatabaseInstance () {
- return $this->dbInstance;
+ protected final function getLanguageInstance () {
+ return self::$langInstance;
}
/**
- * Setter for compressor channel
+ * Setter for language instance
*
- * @param $compressorChannel An instance of CompressorChannel
+ * @param $langInstance An instance to the language sub-system
* @return void
+ * @see LanguageSystem
*/
- public final function setCompressorChannel (CompressorChannel $compressorChannel) {
- self::$compressor = $compressorChannel;
- }
-
- /**
- * Getter for compressor channel
- *
- * @return $compressor The compressor channel
- */
- public final function getCompressorChannel () {
- return self::$compressor;
+ public final function setLanguageInstance (ManageableLanguage $langInstance) {
+ self::$langInstance = $langInstance;
}
/**
return $str;
}
- /**
- * Private getter for language instance
- *
- * @return $langInstance An instance to the language sub-system
- */
- protected final function getLanguageInstance () {
- return $this->langInstance;
- }
-
- /**
- * Setter for language instance
- *
- * @param $langInstance An instance to the language sub-system
- * @return void
- * @see LanguageSystem
- */
- public final function setLanguageInstance (ManageableLanguage $langInstance) {
- $this->langInstance = $langInstance;
- }
-
/**
* Private getter for file IO instance
*
- * @return $fileIOInstance An instance to the file I/O sub-system
+ * @return $fileIoInstance An instance to the file I/O sub-system
*/
protected final function getFileIoInstance () {
- return $this->fileIOInstance;
+ return $this->fileIoInstance;
}
/**
* Setter for file I/O instance
*
- * @param $fileIOInstance An instance to the file I/O sub-system
- * @return void
- */
- public final function setFileIoInstance (FileIoHandler $fileIOInstance) {
- $this->fileIOInstance = $fileIOInstance;
- }
-
- /**
- * Protected getter for a manageable application helper class
- *
- * @return $applicationInstance An instance of a manageable application helper class
- */
- protected final function getApplicationInstance () {
- return $this->applicationInstance;
- }
-
- /**
- * Setter for a manageable application helper class
- *
- * @param $applicationInstance An instance of a manageable application helper class
+ * @param $fileIoInstance An instance to the file I/O sub-system
* @return void
*/
- public final function setApplicationInstance (ManageableApplication $applicationInstance) {
- $this->applicationInstance = $applicationInstance;
+ public final function setFileIoInstance (FileIoHandler $fileIoInstance) {
+ $this->fileIoInstance = $fileIoInstance;
}
/**
- * Prepare the template engine (TemplateEngine by default) for a given
+ * Prepare the template engine (WebTemplateEngine by default) for a given
* application helper instance (ApplicationHelper by default).
*
* @param $appInstance An application helper instance or
}
// Initialize the template engine
- $tplEngine = ObjectFactory::createObjectByConfiguredName('tpl_engine', array($fqfn, $appInstance->getLanguageInstance(), $appInstance->getFileIoInstance()));
+ $tplEngine = ObjectFactory::createObjectByConfiguredName('template_class', array($fqfn, $appInstance->getLanguageInstance(), $appInstance->getFileIoInstance()));
// Return the prepared instance
return $tplEngine;
);
// Output it
- ApplicationEntryPoint::app_die(sprintf("<strong>%s debug output:</strong>%s", $this->__toString(), $content));
+ ApplicationEntryPoint::app_die(sprintf("<strong>%s debug output:</strong><div id=\"debug_content\">%s</div>Loaded includes: <div id=\"debug_include_list\">%s</div>",
+ $this->__toString(),
+ $content,
+ ClassLoader::getInstance()->getPrintableIncludeList()
+ ));
}
/**
$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'];
+ $methodName = $backtrace[1]['class']."->".$backtrace[1]['function'];
}
// Construct the full message
// Is the extra message given?
if (!empty($message)) {
// Then add it as well
- $stubMessage .= sprintf(" Message: <u>%s</u>", $message);
+ $stubMessage .= sprintf(" Message: <span id=\"stub_message\">%s</span>", $message);
}
// Debug instance is there?
}
}
+ /**
+ * Outputs a debug backtrace and stops further script execution
+ *
+ * @return void
+ */
+ public function debugBackTrace () {
+ // Sorry, there is no other way getting this nice backtrace
+ print "<pre>\n";
+ debug_print_backtrace();
+ print "</pre>";
+ exit;
+ }
+
+ /**
+ * Outputs a debug message wether to debug instance (should be set!) or dies with or pints the message
+ *
+ * @param $message Message we shall send out...
+ * @param $doPrint Wether we shall print or die here which last is the default
+ * @return void
+ */
+ public function debugOutput ($message, $doPrint = false) {
+ // Get debug instance
+ $debugInstance = $this->getDebugInstance();
+
+ // Is the debug instance there?
+ if (is_object($debugInstance)) {
+ // Use debug output handler
+ $debugInstance->output($message);
+ if (!$doPrint) die(); // Die here if not printed
+ } else {
+ // Put directly out
+ // DO NOT REWRITE THIS TO app_die() !!!
+ if ($doPrint) {
+ print($message);
+ } else {
+ die($message);
+ }
+ }
+ }
+
/**
* Converts e.g. a command from URL to a valid class by keeping out bad characters
*
* @return $className Generated class name
*/
public function convertToClassName ($str) {
+ // Init class name
$className = "";
+
+ // Convert all dashes in underscores
+ $str = str_replace("-", "_", $str);
+
+ // Now use that underscores to get classname parts for hungarian style
foreach (explode("_", $str) as $strPart) {
+ // Make the class name part lower case and first upper case
$className .= ucfirst(strtolower($strPart));
- }
+ } // END - foreach
+
+ // Return class name
return $className;
}
/**
- * Outputs a debug backtrace and stops further script execution
+ * Marks up the code by adding e.g. line numbers
*
- * @return void
+ * @param $phpCode Unmarked PHP code
+ * @return $markedCode Marked PHP code
*/
- public function debugBacktrace () {
- // Sorry, there is no other way getting this nice backtrace
- print "<pre>\n";
- debug_print_backtrace();
- print "</pre>";
- exit;
+ public function markupCode ($phpCode) {
+ // Get last error
+ $errorArray = error_get_last();
+
+ // Init the code with error message
+ $markedCode = "";
+ if (is_array($errorArray)) {
+ // Get error infos
+ $markedCode = sprintf("<div id=\"error_header\">File: <span id=\"error_data\">%s</span>, Line: <span id=\"error_data\">%s</span>, Message: <span id=\"error_data\">%s</span>, Type: <span id=\"error_data\">%s</span></div>",
+ basename($errorArray['file']),
+ $errorArray['line'],
+ $errorArray['message'],
+ $errorArray['type']
+ );
+ } // END - if
+
+ // Add line number to the code
+ foreach (explode("\n", $phpCode) as $lineNo=>$code) {
+ // Add line numbers
+ $markedCode .= sprintf("<span id=\"code_line\">%s</span>: %s\n",
+ ($lineNo+1),
+ htmlentities($code, ENT_QUOTES)
+ );
+ } // END - foreach
+
+ // Return the code
+ return $markedCode;
}
}