*
* @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 $templateInstance = null;
/**
- * The real class name
+ * Database result instance
*/
- private $realClass = "FrameworkSystem";
+ private $resultInstance = null;
/**
- * A human-readable description for this simulator part
+ * Instance for user class
*/
- private $objectDescription = "Namenlose Framework-Einheit";
+ private $userInstance = null;
/**
- * The unique ID string for identifying all type of classes
+ * The real class name
*/
- private $uniqueID = "";
+ private $realClass = "FrameworkSystem";
/**
* Thousands seperator
const EXCEPTION_MISSING_FILE_IO_HANDLER = 0x02f;
const EXCEPTION_MISSING_ELEMENT = 0x030;
const EXCEPTION_HEADERS_ALREADY_SENT = 0x031;
- const EXCEPTION_DEFAUL_CONTROLLER_GONE = 0x032;
+ 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;
+ const EXCEPTION_DATABASE_UPDATED_NOT_ALLOWED = 0x039;
/**
* 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
* 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.",
- __CLASS__, $this->__toString()
- ));
- } // END - if
-
+ 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->resetUniqueID();
+ $this->setRealClass('DestructedObject');
} 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.",
+ $this->debugOutput(sprintf("[%s:] The object <strong>%s</strong> is already destroyed.",
__CLASS__, $this->__toString()
));
}
} elseif (is_array($args)) {
// Some arguments are there
foreach ($args as $arg) {
- // Check the type
- if (is_bool($arg)) {
- // Boolean!
- if ($arg) $argsString .= "true(bool)"; else $argsString .= "false(bool)";
- } elseif (is_int($arg)) {
- // Integer
- $argsString .= $arg."(int)";
- } elseif (is_float($arg)) {
- // Floating point
- $argsString .= $arg."(float)";
- } elseif ($arg instanceof BaseFrameworkSystem) {
- // Own object instance
- $argsString .= $arg->__toString()."(Object)";
- } elseif (is_object($arg)) {
- // External object
- $argsString .= "unknown object(!)";
- } elseif (is_array($arg)) {
- // Array
- $argsString .= "Array(array)";
- } elseif (is_string($arg)) {
- // String
- $argsString .= "\"".$arg."\"(string)";
- } elseif (is_null($arg)) {
- // Null
- $argsString .= "(null)";
- } elseif (is_resource($arg)) {
- // Resource
- $argsString .= "(resource)";
- } else {
- // Unknown type (please report!)
- $argsString .= $arg."(<em>unknown!</em>)";
- }
-
- // Add comma
- $argsString .= ", ";
- }
+ // Add the type
+ $argsString .= $arg." (".gettype($arg)."), ";
+ } // END - foreach
// Remove last comma
if (substr($argsString, -2, 1) === ",") {
}
// Output stub message
- $this->getDebugInstance()->output(sprintf("[%s->%s] Stub! Args: %s",
+ $this->debugOutput(sprintf("[%s->%s] Stub! Args: %s",
$this->__toString(),
$methodName,
$argsString
)));
// 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
*
*
* @return $cfgInstance Configuration instance
*/
- protected final function getConfigInstance () {
+ public final function getConfigInstance () {
$cfgInstance = Registry::getRegistry()->getInstance('config');
return $cfgInstance;
}
* @return $dbInstance The database layer instance
*/
public final function getDatabaseInstance () {
+ // Default is invalid db instance
+ $dbInstance = null;
+
+ // Is the registry there and initialized?
if ((class_exists('Registry')) && (Registry::isInitialized() === true)) {
- return Registry::getRegistry()->getInstance('dbInstance');
- } else {
- return null;
- }
+ $dbInstance = Registry::getRegistry()->getInstance('dbInstance');
+ } // END - if
+
+ // Return instance
+ return $dbInstance;
}
/**
$this->realClass = $realClass;
}
- /**
- * Generate unique ID from a lot entropy
- *
- * @return void
- */
- public final function generateUniqueId () {
- // Is the id set for this class?
- if (empty($this->uniqueID)) {
-
- // Correct missing class name
- $corrected = false;
- if ($this->__toString() == "") {
- $this->setRealClass(__CLASS__);
- $corrected = true;
- }
-
- // Cache datbase instance
- $db = $this->getDatabaseInstance();
-
- // Generate new id
- $tempID = false;
- while (true) {
- // Generate a unique ID number
- $tempID = $this->generateIdNumber();
- $isUsed = false;
-
- // Try to figure out if the ID number is not yet used
- try {
- // 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 ;-)
- }
-
- if (
- (
- $tempID !== false
- ) && (
- (
- $db === null
- ) || (
- (
- is_object($db)
- ) && (
- !$isUsed
- )
- )
- )
- ) {
- // Abort the loop
- break;
- }
- } // END - while
-
- // Apply the new ID
- $this->setUniqueID($tempID);
-
- // Revert maybe corrected class name
- if ($corrected) {
- $this->setRealClass("");
- }
-
- // Remove system classes if we are in a system class
- if ((isset($this->systemClasses)) && (in_array($this->__toString(), $this->systemClasses))) {
- // This may save some RAM...
- $this->removeSystemArray();
- }
- }
- }
-
- /**
- * Generates a new ID number for classes based from the class' real name,
- * the description and some random data
- *
- * @return $tempID The new (temporary) ID number
- */
- private final function generateIdNumber () {
- return sprintf("%s@%s",
- $this->__toString(),
- md5(sprintf("%s:%s:%s:%s:%s:%s",
- $this->__toString(),
- $this->getObjectDescription(),
- time(),
- getenv('REMOTE_ADDR'),
- getenv('SERVER_ADDR'),
- mt_rand()
- ))
- );
- }
-
- /**
- * Setter for unique ID
- *
- * @param $uniqueID The newly generated unique ID number
- * @return void
- */
- private final function setUniqueID ($uniqueID) {
- // Cast to string
- $uniqueID = (string) $uniqueID;
-
- // Set the ID number
- $this->uniqueID = $uniqueID;
- }
-
- /**
- * Getter for unique ID
- *
- * @return $uniqueID The unique ID of this class
- */
- public final function getUniqueID () {
- return $this->uniqueID;
- }
-
- /**
- * Resets or recreates the unique ID number
- *
- * @return void
- */
- public final function resetUniqueID() {
- // Sweet and simple... ;-)
- $newUniqueID = $this->generateIdNumber();
- $this->setUniqueID($newUniqueID);
- }
-
- /**
- * Getter for simulator description
- *
- * @return $objectDescription The description of this simulation part
- */
- public final function getObjectDescription () {
- if (isset($this->objectDescription)) {
- return $this->objectDescription;
- } else {
- return null;
- }
- }
-
- /**
- * Setter for simulation part description
- *
- * @param $objectDescription The description as string for this simulation part
- * @return void
- */
- public final function setObjectDescription ($objectDescription) {
- $this->objectDescription = (String) $objectDescription;
- }
-
- /**
- * Validate if given object is the same as current
- *
- * @param $object An object instance for comparison with this class
- * @return boolean The result of comparing both's unique ID
- */
- public final function equals (FrameworkInterface $object) {
- return ($this->getUniqueID() == $object->getUniqueID());
- }
-
/**
* Compare if both simulation part description and class name matches
- * (shall be enougth)
+ * (shall be enough)
*
* @param $itemInstance An object instance to an other class
* @return boolean The result of comparing class name simulation part description
+ * @deprecated
*/
public function itemMatches ($itemInstance) {
+ $this->partialStub("Deprecated!");
return (
(
$this->__toString() == $itemInstance->__toString()
unset($this->systemClasses);
}
- /**
- * Create a file name and path name from the object's unique ID number.
- * 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
- * @throws InvalidArrayCountException If the array contains less or
- * more than two elements
- */
- public final function getPathFileNameFromObject () {
- // Get the main object's unique ID. We use this as a path/filename combination
- $pathFile = $this->getUniqueID();
-
- // Split it up in path and file name
- $pathFile = explode("@", $pathFile);
-
- // 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);
- } elseif (count($pathFile) != 2) {
- // Invalid ID returned!
- throw new InvalidArrayCountException(array($this, "pathFile", count($pathFile), 2), self::EXCEPTION_ARRAY_HAS_INVALID_COUNT);
- }
-
- // Auto-append missing trailing slash
- $pathFile[0] = $this->addMissingTrailingSlash($pathFile[0]);
-
- // Create the file name and return it
- $pfn = ($pathFile[0] . $pathFile[1]);
- return $pfn;
- }
-
/**
* Appends a trailing slash to a string
*
*
* @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
if (is_null($appInstance)) {
// Thrown an exception
throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
- }
- }
+ } // END - if
+ } // END - if
// Generate FQFN for all application templates
$fqfn = sprintf("%s%s/%s/%s",
}
// Initialize the template engine
- $tplEngine = ObjectFactory::createObjectByConfiguredName('template_class', 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;
}
/**
* @return void
*/
public final function debugInstance () {
+ // Restore the error handler to avoid trouble with missing array elements or undeclared variables
+ restore_error_handler();
+
// Generate the output
$content = sprintf("<pre>%s</pre>",
- trim(print_r($this, true))
+ trim(
+ htmlentities(
+ print_r($this, true)
+ )
+ )
);
// Output it
- ApplicationEntryPoint::app_die(sprintf("<strong>%s debug output:</strong><div id=\"debug_content\">%s</div>Loaded includes: <div id=\"debug_include_list\">%s</div>",
+ ApplicationEntryPoint::app_die(sprintf("<strong>%s debug output:</strong><div id=\"debug_content\">%s</div>
\nLoaded includes: <div id=\"debug_include_list\">%s</div>",
$this->__toString(),
$content,
ClassLoader::getInstance()->getPrintableIncludeList()
$methodName = "UnknownClass->unknownMethod";
if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
$methodName = $backtrace[1]['class']."->".$backtrace[1]['function'];
- }
+ } // END - if
// Construct the full message
$stubMessage = sprintf("[%s:] Partial stub!",
if (!empty($message)) {
// Then add it as well
$stubMessage .= sprintf(" Message: <span id=\"stub_message\">%s</span>", $message);
- }
+ } // END - if
// Debug instance is there?
if (!is_null($this->getDebugInstance())) {
// Output stub message
- $this->getDebugInstance()->output($stubMessage);
+ $this->debugOutput($stubMessage);
} else {
// Trigger an error
trigger_error($stubMessage."<br />\n");
*
* @return void
*/
- public function debugBacktrace () {
+ public function debugBackTrace () {
// Sorry, there is no other way getting this nice backtrace
print "<pre>\n";
debug_print_backtrace();
* 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
+ * @param $doPrint Wether we shall print or die here which first is the default
* @return void
*/
- public function debugOutput ($message, $doPrint = false) {
+ public function debugOutput ($message, $doPrint = true) {
// Get debug instance
$debugInstance = $this->getDebugInstance();
if (!$doPrint) die(); // Die here if not printed
} else {
// Put directly out
- // DO NOT REWRITE THIS TO app_die() !!!
if ($doPrint) {
print($message);
} else {
+ // DO NOT REWRITE THIS TO app_die() !!!
die($message);
}
}
* @return $markedCode Marked PHP code
*/
public function markupCode ($phpCode) {
+ // Init marked code
+ $markedCode = "";
+
// 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>",
foreach (explode("\n", $phpCode) as $lineNo=>$code) {
// Add line numbers
$markedCode .= sprintf("<span id=\"code_line\">%s</span>: %s\n",
- ($lineNo+1),
+ ($lineNo + 1),
htmlentities($code, ENT_QUOTES)
);
} // END - foreach
// Return the code
return $markedCode;
}
+
+ /**
+ * Filter a given GMT timestamp (non Uni* stamp!) to make it look more
+ * beatiful 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 {
+ 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]);
+
+ // Construct the timestamp
+ $readable = sprintf($this->getConfigInstance()->readConfig('german_date_time'),
+ $dateArray[0],
+ $dateArray[1],
+ $dateArray[2],
+ $timeArray[0],
+ $timeArray[1],
+ $timeArray[2]
+ );
+ break;
+
+ default: // Default is pass-through
+ $readable = $timestamp;
+ break;
+ }
+ }
+
+ // Return the stamp
+ return $readable;
+ }
+
+ /**
+ * "Getter" for databse entry
+ *
+ * @return $entry An array with database entries
+ * @throws NullPointerException If the database result is not found
+ * @throws InvalidDatabaseResultException If the database result is invalid
+ */
+ protected final function getDatabaseEntry () {
+ // Is there an instance?
+ if (is_null($this->getResultInstance())) {
+ // Throw an exception here
+ throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
+ } // END - if
+
+ // Rewind it
+ $this->getResultInstance()->rewind();
+
+ // Do we have an entry?
+ if (!$this->getResultInstance()->valid()) {
+ throw new InvalidDatabaseResultException(array($this, $this->getResultInstance()), DatabaseResult::EXCEPTION_INVALID_DATABASE_RESULT);
+ } // END - if
+
+ // Get next entry
+ $this->getResultInstance()->next();
+
+ // Fetch it
+ $entry = $this->getResultInstance()->current();
+
+ // And return it
+ return $entry;
+ }
+
+ /**
+ * Getter for field name
+ *
+ * @param $fieldName Field name which we shall get
+ * @return $fieldValue Field value from the user
+ * @throws NullPointerException If the result instance is null
+ */
+ public final function getField ($fieldName) {
+ // Default field value
+ $fieldValue = null;
+
+ // Get result instance
+ $resultInstance = $this->getResultInstance();
+
+ // Is this instance null?
+ if (is_null($resultInstance)) {
+ // Then the user instance is no longer valid (expired cookies?)
+ throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
+ } // END - if
+
+ // Get current array
+ $fieldArray = $resultInstance->current();
+
+ // Does the field exist?
+ if (isset($fieldArray[$fieldName])) {
+ // Get it
+ $fieldValue = $fieldArray[$fieldName];
+ } // END - if
+
+ // Return it
+ return $fieldValue;
+ }
+
+ /**
+ * Protected setter for user instance
+ *
+ * @param $userInstance An instance of a user class
+ * @return void
+ */
+ protected final function setUserInstance (ManageableAccount $userInstance) {
+ $this->userInstance = $userInstance;
+ }
+
+ /**
+ * Getter for user instance
+ *
+ * @return $userInstance An instance of a user class
+ */
+ public final function getUserInstance () {
+ return $this->userInstance;
+ }
}
// [EOF]
projects / shipsimu.git / blobdiff