*
* @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
*
*/
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 $applicationInstance = null;
+ private $searchInstance = null;
/**
- * The real class name
+ * The file I/O instance for the template loader
*/
- private $realClass = "FrameworkSystem";
+ private $fileIoInstance = null;
/**
- * A human-readable description for this simulator part
+ * Resolver instance
*/
- private $objectDescription = "Namenlose Framework-Einheit";
+ private $resolverInstance = null;
/**
- * The unique ID string for identifying all type of classes
+ * Template engine instance
*/
- private $uniqueID = "";
+ private $templateInstance = null;
/**
- * Thousands seperator
+ * Database result instance
*/
- private $thousands = "."; // German
+ private $resultInstance = null;
/**
- * Decimal seperator
+ * Instance for user class
*/
- private $decimals = ","; // German
+ private $userInstance = null;
/**
- * The language instance for the template loader
+ * The real class name
*/
- private $langInstance = null;
+ private $realClass = "FrameworkSystem";
/**
- * The file I/O instance for the template loader
+ * Thousands seperator
*/
- private $fileIOInstance = null;
+ private $thousands = "."; // German
+
+ /**
+ * Decimal seperator
+ */
+ private $decimals = ","; // German
/***********************
* 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_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;
+ 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
+ "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 class Registry is there
+ if ((class_exists('Registry')) && (Registry::isInitialized() === false)) {
+ // Initialize the registry automatically
+ $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->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.<br />\n",
+ $this->debugOutput(sprintf("[%s:] The object <span class=\"object_name\">%s</span> is already destroyed.",
__CLASS__, $this->__toString()
));
}
*/
public final function __call ($methodName, $args) {
// Implode all given arguments
- $argsString = implode("|", $args);
- if (empty($argsString)) $argsString = "NULL";
+ $argsString = "";
+ if (empty($args)) {
+ // No arguments
+ $argsString = "NULL";
+ } elseif (is_array($args)) {
+ // Some arguments are there
+ foreach ($args as $arg) {
+ // Add the type
+ $argsString .= $arg." (".gettype($arg);
+
+ // Add length if type is string
+ if (gettype($arg) == 'string') $argsString .= ", ".strlen($arg);
+
+ // Closing bracket
+ $argsString .= "), ";
+ } // END - foreach
+
+ // Remove last comma
+ 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->debugOutput(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)) {
+ // Set configuration instance
+ $this->setConfigInstance(FrameworkConfiguration::getInstance());
+
+ // 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",
+ $this->getConfigInstance()->readConfig('base_path'),
+ $this->getConfigInstance()->readConfig('compressor_base_path')
+ )));
+
+ // Initialization done! :D
+ Registry::isInitialized('OK');
+ } elseif ($this->__toString() == 'DebugMiddleware') {
+ // Set configuration instance
+ $this->setConfigInstance(FrameworkConfiguration::getInstance());
+ }
+ }
- // 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")));
- }
+ /**
+ * 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;
+ }
- // Initialize web instance
- if (is_null($this->getWebOutputInstance())) {
- // Generate the eval() command
- $eval = sprintf("\$this->setWebOutputInstance(%s::create%s(\"%s\"));",
- $this->getConfigInstance()->readConfig("web_engine"),
- $this->getConfigInstance()->readConfig("web_engine"),
- $this->getConfigInstance()->readConfig("web_content_type")
- );
-
- // Debug message
- if (defined('DEBUG_EVAL')) $this->getDebugInstance()->output(sprintf("[%s:] Constructed PHP command: <pre><em>%s</em></pre><br />\n",
- $this->__toString(),
- htmlentities($eval)
- ));
-
- // Run the command
- eval($eval);
- }
+ /**
+ * Getter for database result instance
+ *
+ * @return $resultInstance An instance of a database result class
+ */
+ public final function getResultInstance () {
+ return $this->resultInstance;
+ }
- // 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")
- )));
- }
+ /**
+ * 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 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);
- }
- }
- }
+ /**
+ * 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
*
- * @param $configInstance The configuration instance which shall
- * be FrameworkConfiguration
+ * @param $configInstance The configuration instance which shall
+ * be FrameworkConfiguration
* @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 $realClass
+ * Getter for database layer
*
- * @return $realClass The name of the real class (not BaseFrameworkSystem)
+ * @return $dbInstance The database layer instance
*/
- public final function __toString () {
- return $this->realClass;
+ public final function getDatabaseInstance () {
+ // Default is invalid db instance
+ $dbInstance = null;
+
+ // Is the registry there and initialized?
+ if ((class_exists('Registry')) && (Registry::isInitialized() === true)) {
+ $dbInstance = Registry::getRegistry()->getInstance('dbInstance');
+ } // END - if
+
+ // Return instance
+ return $dbInstance;
}
/**
- * Setter for the real class name
+ * Setter for compressor channel
*
- * @param $realClass Class name (string)
+ * @param $compressorChannel An instance of CompressorChannel
* @return void
*/
- public final function setRealClass ($realClass) {
- // Cast to string
- $realClass = (string) $realClass;
-
- // Set real class
- $this->realClass = $realClass;
+ public final function setCompressorChannel (CompressorChannel $compressorChannel) {
+ Registry::getRegistry()->addInstance('compressor', $compressorChannel);
}
/**
- * Generate unique ID from a lot entropy
+ * Getter for compressor channel
*
- * @return void
+ * @return $compressor The compressor channel
*/
- public final function createUniqueID () {
- // Existiert noch keine?
- if (empty($this->uniqueID)) {
-
- // Correct missing class name
- $corrected = false;
- if ($this->__toString() == "") {
- $this->setRealClass(__CLASS__);
- $corrected = true;
- }
-
- // Neue ID erstellen
- $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 {
- if (is_object($this->getDatabaseInstance())) {
- $isUsed = $this->getDatabaseInstance()->isUniqueIdUsed($tempID, true);
- }
- } catch (FrameworkException $e) {
- // Catches all and ignores all ;-)
- }
-
- if (
- (
- $tempID !== false
- ) && (
- (
- $this->getDatabaseInstance() === null
- ) || (
- (
- is_object($this->getDatabaseInstance())
- ) && (
- !$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();
- }
- }
+ public final function getCompressorChannel () {
+ return Registry::getRegistry()->getInstance('compressor');
}
/**
- * Generates a new ID number for classes based from the class' real name,
- * the description and some random data
+ * Protected getter for a manageable application helper class
*
- * @return $tempID The new (temporary) ID number
+ * @return $applicationInstance An instance of a manageable application helper class
*/
- 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()
- ))
- );
+ protected final function getApplicationInstance () {
+ return self::$applicationInstance;
}
/**
- * Setter for unique ID
+ * Setter for a manageable application helper class
*
- * @param $uniqueID The newly generated unique ID number
+ * @param $applicationInstance An instance of a manageable application helper class
* @return void
*/
- private final function setUniqueID ($uniqueID) {
- // Cast to string
- $uniqueID = (string) $uniqueID;
-
- // Set the ID number
- $this->uniqueID = $uniqueID;
+ public final function setApplicationInstance (ManageableApplication $applicationInstance) {
+ self::$applicationInstance = $applicationInstance;
}
/**
- * Getter for unique ID
+ * Setter for request instance
*
- * @return $uniqueID The unique ID of this class
+ * @param $requestInstance An instance of a Requestable class
+ * @return void
*/
- public final function getUniqueID () {
- return $this->uniqueID;
+ public final function setRequestInstance (Requestable $requestInstance) {
+ $this->requestInstance = $requestInstance;
}
/**
- * Resets or recreates the unique ID number
+ * Getter for request instance
*
- * @return void
+ * @return $requestInstance An instance of a Requestable class
*/
- public final function resetUniqueID() {
- // Sweet and simple... ;-)
- $newUniqueID = $this->generateIdNumber();
- $this->setUniqueID($newUniqueID);
+ public final function getRequestInstance () {
+ return $this->requestInstance;
}
/**
- * Getter for simulator description
+ * Setter for response instance
*
- * @return $objectDescription The description of this simulation part
+ * @param $responseInstance An instance of a Responseable class
+ * @return void
*/
- public final function getObjectDescription () {
- if (isset($this->objectDescription)) {
- return $this->objectDescription;
- } else {
- return null;
- }
+ public final function setResponseInstance (Responseable $responseInstance) {
+ $this->responseInstance = $responseInstance;
}
/**
- * Setter for simulation part description
+ * Getter for response instance
*
- * @param $objectDescription The description as string for this simulation part
- * @return void
+ * @return $responseInstance An instance of a Responseable class
*/
- public final function setObjectDescription ($objectDescription) {
- $this->objectDescription = (String) $objectDescription;
+ public final function getResponseInstance () {
+ return $this->responseInstance;
}
/**
- * Validate if given object is the same as current
+ * Getter for $realClass
*
- * @param $object An object instance for comparison with this class
- * @return boolean The result of comparing both's unique ID
+ * @return $realClass The name of the real class (not BaseFrameworkSystem)
*/
- public final function equals ($object) {
- return ($this->getUniqueID() == $object->getUniqueID());
+ public final function __toString () {
+ return $this->realClass;
}
/**
- * Compare if both simulation part description and class name matches
- * (shall be enougth)
+ * Setter for the real class name
*
- * @param $itemInstance An object instance to an other class
- * @return boolean The result of comparing class name simulation part description
+ * @param $realClass Class name (string)
+ * @return void
*/
- public function itemMatches ($itemInstance) {
- return (
- (
- $this->__toString() == $itemInstance->__toString()
- ) && (
- $this->getObjectDescription() == $itemInstance->getObjectDescription()
- )
- );
+ public final function setRealClass ($realClass) {
+ // Cast to string
+ $realClass = (string) $realClass;
+
+ // Set real class
+ $this->realClass = $realClass;
}
/**
* 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);
}
/**
* Stub method (only real cabins shall override it)
*
* @return boolean false = is no cabin, true = is a cabin
+ * @deprecated
*/
public function isCabin () {
return false;
*
* @return boolean false = is not tradeable by the Merchant class,
* true = is a tradeable object
+ * @deprecated
*/
public function isTradeable () {
return false;
* Formats computer generated price values into human-understandable formats
* with thousand and decimal seperators.
*
- * @param $value The in computer format value for a price
- * @param $currency The currency symbol (use HTML-valid characters!)
- * @param $decNum Number of decimals after commata
- * @return $price The for the current language formated price string
+ * @param $value The in computer format value for a price
+ * @param $currency The currency symbol (use HTML-valid characters!)
+ * @param $decNum Number of decimals after commata
+ * @return $price The for the current language formated price string
* @throws MissingDecimalsThousandsSeperatorException If decimals or
* thousands seperator
* is missing
}
/**
- * 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;
}
/**
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
*
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;
+ protected final function getFileIoInstance () {
+ return $this->fileIoInstance;
}
/**
* Setter for file I/O instance
*
- * @param $fileIOInstance An instance to the file I/O sub-system
+ * @param $fileIoInstance An instance to the file I/O sub-system
* @return void
*/
- public final function setFileIOInstance (FileIOHandler $fileIOInstance) {
- $this->fileIOInstance = $fileIOInstance;
+ 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
- * @return void
- */
- public final function setApplicationInstance (ManageableApplication $applicationInstance) {
- $this->applicationInstance = $applicationInstance;
- }
-
- /**
- * 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
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",
- PATH,
- $this->getConfigInstance()->readConfig("application_path"),
+ $fqfn = sprintf("%s%s/%s",
+ $this->getConfigInstance()->readConfig('application_path'),
strtolower($appInstance->getAppShortName()),
- $this->getConfigInstance()->readConfig("tpl_base_path")
+ $this->getConfigInstance()->readConfig('tpl_base_path')
);
// Are both instances set?
if ($appInstance->getLanguageInstance() === null) {
// Invalid language instance
throw new MissingLanguageHandlerException($appInstance, self::EXCEPTION_MISSING_LANGUAGE_HANDLER);
- } elseif ($appInstance->getFileIOInstance() === null) {
+ } elseif ($appInstance->getFileIoInstance() === null) {
// Invalid language instance
throw new MissingFileIoHandlerException($appInstance, self::EXCEPTION_MISSING_FILE_IO_HANDLER);
}
// Initialize the template engine
- $tplEngine = null;
- $eval = sprintf("\$tplEngine = %s::create%s(
- \"%s\",
- \$appInstance->getLanguageInstance(),
- \$appInstance->getFileIOInstance()
-);",
- $this->getConfigInstance()->readConfig("tpl_engine"),
- $this->getConfigInstance()->readConfig("tpl_engine"),
- $fqfn
+ $templateInstance = ObjectFactory::createObjectByConfiguredName('template_class', array($fqfn, $appInstance->getLanguageInstance(), $appInstance->getFileIoInstance()));
+
+ // Return the prepared instance
+ return $templateInstance;
+ }
+
+ /**
+ * Debugs this instance by putting out it's full content
+ *
+ * @param $message Optional message to show in debug output
+ * @return void
+ */
+ 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 = "";
+
+ // Is a message set?
+ if (!empty($message)) {
+ // Construct message
+ $content = sprintf("<div class=\"debug_message\">Message: %s</div>\n", $message);
+ } // END - if
+
+ // Generate the output
+ $content .= sprintf("<pre>%s</pre>",
+ trim(
+ htmlentities(
+ print_r($this, true)
+ )
+ )
);
- // Debug message
- if ((!is_null($this->getDebugInstance())) && (defined('DEBUG_EVAL'))) {
- $this->getDebugInstance()->output(sprintf("[%s:] Constructed PHP command: <pre><em>%s</em></pre><br />\n",
- $this->__toString(),
- htmlentities($eval)
- ));
+ // Output it
+ ApplicationEntryPoint::app_die(sprintf("<div class=\"debug_header\">%s debug output:</div><div class=\"debug_content\">%s</div>\nLoaded includes: <div class=\"debug_include_list\">%s</div>",
+ $this->__toString(),
+ $content,
+ ClassLoader::getInstance()->getPrintableIncludeList()
+ ));
+ }
+
+ /**
+ * Output a partial stub message for the caller method
+ *
+ * @param $message An optional message to display
+ * @return void
+ */
+ protected function partialStub ($message = "") {
+ // Get the backtrace
+ $backtrace = debug_backtrace();
+
+ // Generate the class::method string
+ $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!",
+ $methodName
+ );
+
+ // Is the extra message given?
+ 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->debugOutput($stubMessage);
+ } else {
+ // Trigger an error
+ trigger_error($stubMessage."<br />\n");
}
+ }
- // Run the command
- eval($eval);
+ /**
+ * 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;
+ }
- // Is it a valid instance?
- if (is_null($tplEngine)) {
- // No class returned
- throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
- } elseif (!$tplEngine instanceof CompileableTemplate) {
- // Not an object! ;-(
- throw new UnsupportedTemplateEngineException($tplEngine, self::EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED);
+ /**
+ * 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 first is the default
+ * @return void
+ */
+ public function debugOutput ($message, $doPrint = true) {
+ // Get debug instance
+ $debugInstance = $this->getDebugInstance();
+
+ // Is the debug instance there?
+ if (is_object($debugInstance)) {
+ // Use debug output handler
+ $debugInstance->output($message);
+ if ($doPrint === false) die(); // Die here if not printed
+ } else {
+ // Put directly out
+ if ($doPrint) {
+ print($message);
+ } else {
+ // DO NOT REWRITE THIS TO app_die() !!!
+ die($message);
+ }
}
+ }
- // Return the prepared instance
- return $tplEngine;
+ /**
+ * Converts e.g. a command from URL to a valid class by keeping out bad characters
+ *
+ * @param $str The string, what ever it is needs to be converted
+ * @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;
}
/**
- * Debugs this instance by putting out it's full content
+ * Marks up the code by adding e.g. line numbers
+ *
+ * @param $phpCode Unmarked PHP code
+ * @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
+ 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 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() === false) {
+ 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
*/
- public final function debugInstance () {
- // Generate the output
- $content = "<pre>".trim(print_r($this, true))."</pre>";
+ protected final function setUserInstance (ManageableAccount $userInstance) {
+ $this->userInstance = $userInstance;
+ }
- // Output it
- ApplicationEntryPoint::app_die("<strong>Debug output:</strong>".$content);
+ /**
+ * Getter for user instance
+ *
+ * @return $userInstance An instance of a user class
+ */
+ public final function getUserInstance () {
+ return $this->userInstance;
}
}
projects / shipsimu.git / blobdiff