*
* @author Roland Haeder <webmaster@ship-simu.org>
* @version 0.0.0
- * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
* @license GNU GPL 3.0 or any newer version
* @link http://www.ship-simu.org
*
*/
private static $langInstance = null;
+ /**
+ * Debug instance
+ */
+ private static $debugInstance = null;
+
+ /**
+ * Instance of a request class
+ */
+ private $requestInstance = null;
+
+ /**
+ * Instance of a response class
+ */
+ private $responseInstance = null;
+
+ /**
+ * 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 $templateInstance = null;
+
+ /**
+ * Database result instance
+ */
+ private $resultInstance = null;
+
/**
* The real class name
*/
*/
private $decimals = ","; // German
- /**
- * 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
* we would get an endless calling loop.
*
- *--------------------------------------------------------------------*
- * ATTENTION: IF YOU REMOVE ONE OF THEM YOU WILL SHOOT YOUR SERVER!!! *
- *--------------------------------------------------------------------*
+ *---------------------------------------------------------------------*
+ * ATTENTION: IF YOU REMOVE ONE OF THEM YOU WILL RUN YOUR SERVER IN AN *
+ * ENDLESS LOOP !!! *
+ *---------------------------------------------------------------------*
*/
private $systemClasses = array(
"DebugMiddleware", // Debug middleware output sub-system
/**
* 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);
// Initialize the class if the registry is there
if ((class_exists('Registry')) && (Registry::isInitialized() === false)) {
$this->initInstance();
- }
+ } // END - if
}
/**
* Destructor reached...
*
* @return void
+ * @todo This is old code. Do we still need this old lost code?
*/
public function __destruct() {
// Is this object already destroyed?
- 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",
- __CLASS__, $this->__toString()
- ));
- }
-
+ if ($this->__toString() != 'DestructedObject') {
// Destroy all informations about this class but keep some text about it alive
- $this->setObjectDescription(sprintf("Entferntes Objekt <em>%s</em>", $this->__toString()));
- $this->setRealClass("DestructedObject");
+ $this->setObjectDescription(sprintf("Removed object <em>%s</em>", $this->__toString()));
+ $this->setRealClass('DestructedObject');
$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:] The object <strong>%s</strong> is already destroyed.",
__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
$this->systemclasses[] = $this->getConfigInstance()->readConfig('app_helper_class');
// Set debug instance
- $this->setDebugInstance(DebugMiddleware::createDebugMiddleware($this->getConfigInstance()->readConfig('debug_engine')));
+ $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')));
)));
// Initialization done! :D
- Registry::isInitialized("OK");
- } elseif ($this->__toString() == "DebugMiddleware") {
+ Registry::isInitialized('OK');
+ } elseif ($this->__toString() == 'DebugMiddleware') {
// Set configuration instance
$this->setConfigInstance(FrameworkConfiguration::createFrameworkConfiguration());
}
}
+ /**
+ * Setter for database result instance
+ *
+ * @param $resultInstance An instance of a database result class
+ * @return void
+ * @todo SearchableResult and UpdateableResult shall have a super interface to use here
+ */
+ protected final function setResultInstance (SearchableResult $resultInstance) {
+ $this->resultInstance = $resultInstance;
+ }
+
+ /**
+ * Getter for database result instance
+ *
+ * @return $resultInstance An instance of a database result class
+ */
+ public final function getResultInstance () {
+ return $this->resultInstance;
+ }
+
+ /**
+ * 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;
+ }
+
+ /**
+ * Getter for template engine instances
+ *
+ * @return $templateInstance An instance of a template engine class
+ */
+ protected final function getTemplateInstance () {
+ return $this->templateInstance;
+ }
+
+ /**
+ * Setter for search instance
+ *
+ * @param $searchInstance Searchable criteria instance
+ * @return void
+ */
+ public final function setSearchInstance (LocalSearchCriteria $searchInstance) {
+ $this->searchInstance = $searchInstance;
+ }
+
+ /**
+ * Getter for search instance
+ *
+ * @return $searchInstance Searchable criteria instance
+ */
+ public final function getSearchInstance () {
+ return $this->searchInstance;
+ }
+
+ /**
+ * 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;
+ }
+
/**
* Setter for language instance
*
/**
* Getter for configuration instance
*
- * @return $cfhInstance - Configuration instance
+ * @return $cfgInstance Configuration instance
*/
- protected final function getConfigInstance () {
- return Registry::getRegistry()->getInstance('config');
+ 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) {
- Registry::getRegistry()->addInstance('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 Registry::getRegistry()->getInstance('debug');
+ return self::$debugInstance;
}
/**
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;
+ }
+
/**
* Getter for $realClass
*
/**
* 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);
}
/**
* The left part of the ID shall always be a valid class name and the
* right part an ID number.
*
- * @return $pfn The file name with a prepended path name
- * @throws NoArrayCreatedException If explode() fails to create an array
+ * @return $pfn The file name with a prepended path name
+ * @throws NoArrayCreatedException If explode() fails to create an array
* @throws InvalidArrayCountException If the array contains less or
- * more than two elements
+ * more than two elements
*/
public final function getPathFileNameFromObject () {
// Get the main object's unique ID. We use this as a path/filename combination
// Are there two elements? Index 0 is the path, 1 the file name + global extension
if (!is_array($pathFile)) {
// No array found
- throw new NoArrayCreatedException(array($this, "pathFile"), self::EXCEPTION_ARRAY_EXPECTED);
+ throw new NoArrayCreatedException(array($this, 'pathFile'), self::EXCEPTION_ARRAY_EXPECTED);
} elseif (count($pathFile) != 2) {
// Invalid ID returned!
- throw new InvalidArrayCountException(array($this, "pathFile", count($pathFile), 2), self::EXCEPTION_ARRAY_HAS_INVALID_COUNT);
+ throw new InvalidArrayCountException(array($this, 'pathFile', count($pathFile), 2), self::EXCEPTION_ARRAY_HAS_INVALID_COUNT);
}
// Auto-append missing trailing slash
}
/**
- * 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
* null if we shall use the default
- * @return $tplEngine The template engine instance
+ * @return $templateInstance The template engine instance
* @throws NullPointerException If the template engine could not
* be initialized
- * @throws UnsupportedTemplateEngineException If $tplEngine is an
+ * @throws UnsupportedTemplateEngineException If $templateInstance is an
* unsupported template engine
* @throws MissingLanguageHandlerException If the language sub-system
* is not yet initialized
* @throws NullPointerException If the discovered application
* instance is still null
*/
- protected function prepareTemplateEngine (BaseFrameworkSystem $appInstance=null) {
+ protected function prepareTemplateInstance (BaseFrameworkSystem $appInstance=null) {
// Is the application instance set?
if (is_null($appInstance)) {
// Get the current instance
}
// Initialize the template engine
- $tplEngine = ObjectFactory::createObjectByConfiguredName('tpl_engine', array($fqfn, $appInstance->getLanguageInstance(), $appInstance->getFileIoInstance()));
+ $templateInstance = ObjectFactory::createObjectByConfiguredName('template_class', array($fqfn, $appInstance->getLanguageInstance(), $appInstance->getFileIoInstance()));
// Return the prepared instance
- return $tplEngine;
+ return $templateInstance;
}
/**
);
// 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;
+ }
+
+ /**
+ * Filter a given timestamp to make it look more beatifull for web-based
+ * front-ends. If null is given a message id null_timestamp will be
+ * resolved and returned.
+ *
+ * @param $timestamp Timestamp to prepare (filter) for display
+ * @return $readable A readable timestamp
+ */
+ public function doFilterFormatTimestamp ($timestamp) {
+ // Default value to return
+ $readable = "???";
+
+ // Is the timestamp null?
+ if (is_null($timestamp)) {
+ // Get a message string
+ $readable = $this->getLanguageInstance()->getMessage('null_timestamp');
+ } else {
+ $this->partialStub("Do further analysis on timestamp {$timestamp}.");
+ }
+
+ // Return the stamp
+ return $readable;
}
}
projects / shipsimu.git / blobdiff