*
* @author Roland Haeder <webmaster@ship-simu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007 - 2009 Roland Haeder, this is free software
+ * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team
* @license GNU GPL 3.0 or any newer version
* @link http://www.ship-simu.org
*
*/
private $controllerInstance = null;
+ /**
+ * Instance of a RNG
+ */
+ private $rngInstance = null;
+
+ /**
+ * Instance of an Iterator class
+ */
+ private $iteratorInstance = null;
+
+ /**
+ * Instance of the list
+ */
+ private $listInstance = null;
+
+ /**
+ * Instance of a menu
+ */
+ private $menuInstance = null;
+
+ /**
+ * Instance of the image
+ */
+ private $imageInstance = null;
+
+ /**
+ * Instance of the stacker
+ */
+ private $stackerInstance = null;
+
+ /**
+ * A Compressor instance
+ */
+ private $compressorInstance = null;
+
+ /**
+ * A Parseable instance
+ */
+ private $parserInstance = null;
+
/**
* The real class name
*/
- private $realClass = "FrameworkSystem";
+ private $realClass = 'BaseFrameworkSystem';
/**
* Thousands seperator
*/
- private $thousands = "."; // German
+ private $thousands = '.'; // German
/**
* Decimal seperator
*/
- private $decimals = ","; // German
+ private $decimals = ','; // German
/***********************
* Exception codes.... *
***********************/
-
+ // @todo Try to clean these constants up
const EXCEPTION_IS_NULL_POINTER = 0x001;
const EXCEPTION_IS_NO_OBJECT = 0x002;
const EXCEPTION_IS_NO_ARRAY = 0x003;
const EXCEPTION_WRITE_PROTECED_PATH = 0x018;
const EXCEPTION_DIR_POINTER_INVALID = 0x019;
const EXCEPTION_FILE_POINTER_INVALID = 0x01a;
- const EXCEPTION_INVALID_DIRECTORY_POINTER = 0x01b;
+ const EXCEPTION_INVALID_RESOURCE = 0x01b;
const EXCEPTION_UNEXPECTED_OBJECT = 0x01c;
const EXCEPTION_LIMIT_ELEMENT_IS_UNSUPPORTED = 0x01d;
const EXCEPTION_GETTER_IS_MISSING = 0x01e;
const EXCEPTION_DATABASE_UPDATED_NOT_ALLOWED = 0x039;
const EXCEPTION_FILTER_CHAIN_INTERCEPTED = 0x040;
- /**
- * In the super constructor these system classes shall be ignored or else
- * we would get an endless calling loop.
- *
- *---------------------------------------------------------------------*
- * 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
- "FrameworkDirectoryPointer", // Directory handler sub-system
- "NullCompressor", // Null compressor
- "Bzip2Compressor", // BZIP2 compressor
- "GzipCompressor", // GZIP compressor
- );
-
/**
* Protected super constructor
*
// Set real class
$this->setRealClass($className);
- // Initialize the class if class Registry is there
- if ((class_exists('Registry')) && (Registry::isInitialized() === false)) {
- // Initialize the registry automatically
- $this->initInstance();
+ // Set configuration instance if no registry
+ if (!$this instanceof Register) {
+ // Because registries doesn't need to be configured
+ $this->setConfigInstance(FrameworkConfiguration::getInstance());
} // END - if
}
} elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
// Already destructed object
$this->debugOutput(sprintf("[%s:] The object <span class=\"object_name\">%s</span> is already destroyed.",
- __CLASS__, $this->__toString()
+ __CLASS__,
+ $this->__toString()
));
}
}
$argsString = '';
if (empty($args)) {
// No arguments
- $argsString = "NULL";
+ $argsString = 'NULL';
} elseif (is_array($args)) {
// Some arguments are there
foreach ($args as $arg) {
// Add the type
- $argsString .= $arg." (".gettype($arg);
+ $argsString .= $this->replaceControlCharacters($arg) . ' (' . gettype($arg);
// Add length if type is string
- if (gettype($arg) == 'string') $argsString .= ", ".strlen($arg);
+ if (gettype($arg) == 'string') $argsString .= ', '.strlen($arg);
// Closing bracket
- $argsString .= "), ";
+ $argsString .= '), ';
} // END - foreach
// Remove last comma
- if (substr($argsString, -2, 1) === ",") {
+ if (substr($argsString, -2, 1) == ',') {
$argsString = substr($argsString, 0, -2);
} // END - if
} else {
// Invalid arguments!
- $argsString = sprintf("!INVALID:%s!", $args);
+ $argsString = '!INVALID:' . gettype($args) . '!';
}
// Output stub message
return null;
}
- /**
- * Private initializer for this class
- *
- * @return void
- */
- 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());
- }
- }
-
/**
* Setter for database result instance
*
* @return $debugInstance Instance to class DebugConsoleOutput or DebugWebOutput
*/
public final function getDebugInstance () {
+ // Get debug instance
$debugInstance = Registry::getRegistry()->getInstance('debug');
+
+ // Return it
return $debugInstance;
}
* @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)) {
- $dbInstance = Registry::getRegistry()->getInstance('db_instance');
- } // END - if
+ // Get instance
+ $dbInstance = Registry::getRegistry()->getInstance('db_instance');
// Return instance
return $dbInstance;
}
/**
- * Compare class name of this and given class name
+ * Checks wether an object equals this object. You should overwrite this
+ * method to implement own equality checks
*
- * @param $className The class name as string from the other class
- * @return boolean The result of comparing both class names
- */
- 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;
- }
+ * @param $objectInstance An instance of a FrameworkInterface object
+ * @return $equals Wether both objects equals
+ */
+ public function equals (FrameworkInterface $objectInstance) {
+ // Now test it
+ $equals = ((
+ $this->__toString() == $objectInstance->__toString()
+ ) && (
+ $this->hashCode() == $objectInstance->hashCode()
+ ));
- /**
- * Stub method for tradeable objects
- *
- * @return boolean false = is not tradeable by the Merchant class,
- * true = is a tradeable object
- * @deprecated
- */
- public function isTradeable () {
- return false;
+ // Return the result
+ return $result;
}
/**
* thousands seperator
* is missing
*/
- public function formatCurrency ($value, $currency = "€", $decNum = 2) {
+ public function formatCurrency ($value, $currency = '€', $decNum = 2) {
// Are all required attriutes set?
if ((!isset($this->decimals)) || (!isset($this->thousands))) {
// Throw an exception
$value = (float) $value;
// Reformat the US number
- $price = sprintf("%s %s",
- number_format($value, $decNum, $this->decimals, $this->thousands),
- $currency
- );
+ $price = number_format($value, $decNum, $this->decimals, $this->thousands) . $currency;
// Return as string...
return $price;
}
- /**
- * Removes number formating characters
- *
- * @return void
- */
- public final function removeNumberFormaters () {
- unset($this->thousands);
- unset($this->decimals);
- }
-
/**
* Private getter for language instance
*
Registry::getRegistry()->addInstance('language', $langInstance);
}
- /**
- * Remove the $systemClasses array from memory
- *
- * @return void
- */
- public final function removeSystemArray () {
- unset($this->systemClasses);
- }
-
/**
* Appends a trailing slash to a string
*
*/
public final function addMissingTrailingSlash ($str) {
// Is there a trailing slash?
- if (substr($str, -1, 1) != "/") $str .= "/";
+ if (substr($str, -1, 1) != '/') $str .= '/';
return $str;
}
* @throws NullPointerException If the discovered application
* instance is still null
*/
- protected function prepareTemplateInstance (BaseFrameworkSystem $appInstance=null) {
+ protected function prepareTemplateInstance (FrameworkInterface $appInstance=null) {
// Is the application instance set?
if (is_null($appInstance)) {
// Get the current instance
} // END - if
} // END - if
- // Generate FQFN for all application templates
- $fqfn = sprintf("%s%s/%s",
- $this->getConfigInstance()->readConfig('application_path'),
- strtolower($appInstance->getAppShortName()),
- $this->getConfigInstance()->readConfig('tpl_base_path')
- );
-
// Are both instances set?
if ($appInstance->getLanguageInstance() === null) {
// Invalid language instance
}
// Initialize the template engine
- $templateInstance = ObjectFactory::createObjectByConfiguredName('template_class', array($fqfn, $appInstance->getLanguageInstance(), $appInstance->getFileIoInstance()));
+ $templateInstance = ObjectFactory::createObjectByConfiguredName('web_template_class', array($appInstance));
// Return the prepared instance
return $templateInstance;
));
}
+ /**
+ * Replaces control characters with printable output
+ *
+ * @param $str String with control characters
+ * @return $str Replaced string
+ */
+ protected function replaceControlCharacters ($str) {
+ // Replace them
+ $str = str_replace(
+ "\r", '[r]', str_replace(
+ "\n", '[n]', str_replace(
+ "\t", '[t]',
+ $str
+ )));
+
+ // Return it
+ return $str;
+ }
+
/**
* Output a partial stub message for the caller method
*
$backtrace = debug_backtrace();
// Generate the class::method string
- $methodName = "UnknownClass->unknownMethod";
+ $methodName = 'UnknownClass->unknownMethod';
if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
$methodName = $backtrace[1]['class']."->".$backtrace[1]['function'];
} // END - if
if ($doPrint === false) die(); // Die here if not printed
} else {
// Put directly out
- if ($doPrint) {
+ if ($doPrint === true) {
print($message);
} else {
// DO NOT REWRITE THIS TO app_die() !!!
$className = '';
// Convert all dashes in underscores
- $str = str_replace("-", "_", $str);
+ $str = $this->convertDashesToUnderscores($str);
// Now use that underscores to get classname parts for hungarian style
- foreach (explode("_", $str) as $strPart) {
+ foreach (explode('_', $str) as $strPart) {
// Make the class name part lower case and first upper case
$className .= ucfirst(strtolower($strPart));
} // END - foreach
return $className;
}
+ /**
+ * Converts dashes to underscores, e.g. useable for configuration entries
+ *
+ * @param $str The string with maybe dashes inside
+ * @return $str The converted string with no dashed, but underscores
+ */
+ public final function convertDashesToUnderscores ($str) {
+ // Convert them all
+ $str = str_replace('-', '_', $str);
+
+ // Return converted string
+ return $str;
+ }
+
/**
* Marks up the code by adding e.g. line numbers
*
*/
public function doFilterFormatTimestamp ($timestamp) {
// Default value to return
- $readable = "???";
+ $readable = '???';
// Is the timestamp null?
if (is_null($timestamp)) {
$readable = $this->getLanguageInstance()->getMessage('null_timestamp');
} else {
switch ($this->getLanguageInstance()->getLanguageCode()) {
- case "de": // German format is a bit different to default
+ case 'de': // German format is a bit different to default
// Split the GMT stamp up
- $dateTime = explode(" ", $timestamp);
- $dateArray = explode("-", $dateTime[0]);
- $timeArray = explode(":", $dateTime[1]);
+ $dateTime = explode(' ', $timestamp );
+ $dateArray = explode('-', $dateTime[0]);
+ $timeArray = explode(':', $dateTime[1]);
// Construct the timestamp
- $readable = sprintf($this->getConfigInstance()->readConfig('german_date_time'),
+ $readable = sprintf($this->getConfigInstance()->getConfigEntry('german_date_time'),
$dateArray[0],
$dateArray[1],
$dateArray[2],
default: // Default is pass-through
$readable = $timestamp;
break;
- }
+ } // END - switch
}
// Return the stamp
return $readable;
}
+ /**
+ * Filter a given number into a localized number
+ *
+ * @param $value The raw value from e.g. database
+ * @return $localized Localized value
+ */
+ public function doFilterFormatNumber ($value) {
+ // Generate it from config and localize dependencies
+ switch ($this->getLanguageInstance()->getLanguageCode()) {
+ case 'de': // German format is a bit different to default
+ $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), ',', '.');
+ break;
+
+ default: // US, etc.
+ $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), '.', ',');
+ break;
+ } // END - switch
+
+ // Return it
+ return $localized;
+ }
+
/**
* "Getter" for databse entry
*
// Get current array
$fieldArray = $resultInstance->current();
+ //* DEBUG: */ $this->debugOutput($fieldName.':<pre>'.print_r($fieldArray, true).'</pre>');
// Does the field exist?
if (isset($fieldArray[$fieldName])) {
$wrapperInstance->doUpdateByResult($this->getResultInstance());
} // END - if
}
+
+ /**
+ * Outputs a deprecation warning to the developer.
+ *
+ * @param $message The message we shall output to the developer
+ * @return void
+ * @todo Write a logging mechanism for productive mode
+ */
+ public function deprecationWarning ($message) {
+ // Is developer mode active?
+ if (defined('DEVELOPER')) {
+ // Debug instance is there?
+ if (!is_null($this->getDebugInstance())) {
+ // Output stub message
+ $this->debugOutput($message);
+ } else {
+ // Trigger an error
+ trigger_error($message."<br />\n");
+ }
+ } else {
+ // @TODO Finish this part!
+ $this->partialStub('Developer mode inactive. Message:' . $message);
+ }
+ }
+
+ /**
+ * Generates a generic hash code of this class. You should really overwrite
+ * this method with your own hash code generator code. But keep KISS in mind.
+ *
+ * @return $hashCode A generic hash code respresenting this whole class
+ */
+ public function hashCode () {
+ // Simple hash code
+ return crc32($this->__toString());
+ }
+
+ /**
+ * Checks wether the given PHP extension is loaded
+ *
+ * @param $phpExtension The PHP extension we shall check
+ * @return $isLoaded Wether the PHP extension is loaded
+ */
+ public final function isPhpExtensionLoaded ($phpExtension) {
+ // Is it loaded?
+ $isLoaded = in_array($phpExtension, get_loaded_extensions());
+
+ // Return result
+ return $isLoaded;
+ }
+
+ /**
+ * Setter for RNG instance
+ *
+ * @param $rngInstance An instance of a random number generator (RNG)
+ * @return void
+ */
+ protected final function setRngInstance (RandomNumberGenerator $rngInstance) {
+ $this->rngInstance = $rngInstance;
+ }
+
+ /**
+ * Getter for RNG instance
+ *
+ * @return $rngInstance An instance of a random number generator (RNG)
+ */
+ public final function getRngInstance () {
+ return $this->rngInstance;
+ }
+
+ /**
+ * Setter for Iterator instance
+ *
+ * @param $iteratorInstance An instance of an Iterator
+ * @return void
+ */
+ protected final function setIteratorInstance (Iterator $iteratorInstance) {
+ $this->iteratorInstance = $iteratorInstance;
+ }
+
+ /**
+ * Getter for Iterator instance
+ *
+ * @return $iteratorInstance An instance of an Iterator
+ */
+ public final function getIteratorInstance () {
+ return $this->iteratorInstance;
+ }
+
+ /**
+ * "Getter" as a time() replacement but with milliseconds. You should use this
+ * method instead of the encapsulated getimeofday() function.
+ *
+ * @return $milliTime Timestamp with milliseconds
+ */
+ public function getMilliTime () {
+ // Get the time of day as float
+ $milliTime = gettimeofday(true);
+
+ // Return it
+ return $milliTime;
+ }
+
+ /**
+ * Idles (sleeps) for given milliseconds
+ *
+ * @return $hasSlept Wether it goes fine
+ */
+ public function idle ($milliSeconds) {
+ // Sleep is fine by default
+ $hasSlept = true;
+
+ // Idle so long with found function
+ if (function_exists('time_sleep_until')) {
+ // Get current time and add idle time
+ $sleepUntil = $this->getMilliTime() + abs($milliSeconds) / 1000;
+
+ // New PHP 5.1.0 function found
+ $hasSlept = time_sleep_until($sleepUntil);
+ } else {
+ // My Sun Station doesn't have that function even with latest PHP
+ // package. :(
+ usleep($milliSeconds * 1000);
+ }
+
+ // Return result
+ return $hasSlept;
+ }
+
+ /**
+ * Setter for the list instance
+ *
+ * @param $listInstance A list of Listable
+ * @return void
+ */
+ protected final function setListInstance (Listable $listInstance) {
+ $this->listInstance = $listInstance;
+ }
+
+ /**
+ * Getter for the list instance
+ *
+ * @return $listInstance A list of Listable
+ */
+ protected final function getListInstance () {
+ return $this->listInstance;
+ }
+
+ /**
+ * Setter for the menu instance
+ *
+ * @param $menuInstance A RenderableMenu instance
+ * @return void
+ */
+ protected final function setMenuInstance (RenderableMenu $menuInstance) {
+ $this->menuInstance = $menuInstance;
+ }
+
+ /**
+ * Getter for the menu instance
+ *
+ * @return $menuInstance A RenderableMenu instance
+ */
+ protected final function getMenuInstance () {
+ return $this->menuInstance;
+ }
+
+ /**
+ * Setter for image instanxe
+ *
+ * @param $imageInstance An instance of an image
+ * @return void
+ */
+ public final function setImageInstance (BaseImage $imageInstance) {
+ $this->imageInstance = $imageInstance;
+ }
+
+ /**
+ * Getter for image instanxe
+ *
+ * @return $imageInstance An instance of an image
+ */
+ public final function getImageInstance () {
+ return $this->imageInstance;
+ }
+
+ /**
+ * Setter for stacker instanxe
+ *
+ * @param $stackerInstance An instance of an stacker
+ * @return void
+ */
+ public final function setStackerInstance (Stackable $stackerInstance) {
+ $this->stackerInstance = $stackerInstance;
+ }
+
+ /**
+ * Getter for stacker instanxe
+ *
+ * @return $stackerInstance An instance of an stacker
+ */
+ public final function getStackerInstance () {
+ return $this->stackerInstance;
+ }
+
+ /**
+ * Setter for compressor instanxe
+ *
+ * @param $compressorInstance An instance of an compressor
+ * @return void
+ */
+ public final function setCompressorInstance (Compressor $compressorInstance) {
+ $this->compressorInstance = $compressorInstance;
+ }
+
+ /**
+ * Getter for compressor instanxe
+ *
+ * @return $compressorInstance An instance of an compressor
+ */
+ public final function getCompressorInstance () {
+ return $this->compressorInstance;
+ }
+
+ /**
+ * Setter for Parseable instanxe
+ *
+ * @param $parserInstance An instance of an Parseable
+ * @return void
+ */
+ public final function setParserInstance (Parseable $parserInstance) {
+ $this->parserInstance = $parserInstance;
+ }
+
+ /**
+ * Getter for Parseable instanxe
+ *
+ * @return $parserInstance An instance of an Parseable
+ */
+ public final function getParserInstance () {
+ return $this->parserInstance;
+ }
}
// [EOF]
projects / core.git / blobdiff