3 * The simulator system class is the super class of all other classes. This
4 * class handles saving of games etc.
6 * @author Roland Haeder <webmaster@shipsimu.org>
8 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
9 * @license GNU GPL 3.0 or any newer version
10 * @link http://www.shipsimu.org
12 * This program is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation, either version 3 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
27 * Length of output from hash()
29 private static $hashLength = NULL;
34 private $realClass = 'BaseFrameworkSystem';
37 * Instance of a request class
39 private $requestInstance = NULL;
42 * Instance of a response class
44 private $responseInstance = NULL;
47 * Search criteria instance
49 private $searchInstance = NULL;
52 * Update criteria instance
54 private $updateInstance = NULL;
57 * The file I/O instance for the template loader
59 private $fileIoInstance = NULL;
64 private $resolverInstance = NULL;
67 * Template engine instance
69 private $templateInstance = NULL;
72 * Database result instance
74 private $resultInstance = NULL;
77 * Instance for user class
79 private $userInstance = NULL;
82 * A controller instance
84 private $controllerInstance = NULL;
89 private $rngInstance = NULL;
92 * Instance of a crypto helper
94 private $cryptoInstance = NULL;
97 * Instance of an Iterator class
99 private $iteratorInstance = NULL;
102 * Instance of the list
104 private $listInstance = NULL;
109 private $menuInstance = NULL;
112 * Instance of the image
114 private $imageInstance = NULL;
117 * Instance of the stacker
119 private $stackInstance = NULL;
122 * A Compressor instance
124 private $compressorInstance = NULL;
127 * A Parseable instance
129 private $parserInstance = NULL;
132 * A HandleableProtocol instance
134 private $protocolInstance = NULL;
137 * A database wrapper instance
139 private $databaseInstance = NULL;
142 * A helper instance for the form
144 private $helperInstance = NULL;
147 * An instance of a Sourceable class
149 private $sourceInstance = NULL;
152 * An instance of a UrlSource class
154 private $urlSourceInstance = NULL;
157 * An instance of a InputStream class
159 private $inputStreamInstance = NULL;
162 * An instance of a OutputStream class
164 private $outputStreamInstance = NULL;
167 * Networkable handler instance
169 private $handlerInstance = NULL;
172 * Visitor handler instance
174 private $visitorInstance = NULL;
179 private $dhtInstance = NULL;
182 * An instance of a database wrapper class
184 private $wrapperInstance = NULL;
187 * An instance of a file I/O pointer class (not handler)
189 private $pointerInstance = NULL;
192 * An instance of an Indexable class
194 private $indexInstance = NULL;
197 * An instance of a Block class
199 private $blockInstance = NULL;
204 private $minableInstance = NULL;
207 * A FrameworkDirectory instance
209 private $directoryInstance = NULL;
214 private $listenerInstance = NULL;
217 * Thousands separator
219 private $thousands = '.'; // German
224 private $decimals = ','; // German
229 private $socketResource = FALSE;
232 * Regular expression to use for validation
234 private $regularExpression = '';
239 private $packageData = array();
244 private $genericArray = array();
246 /***********************
247 * Exception codes.... *
248 ***********************/
250 // @todo Try to clean these constants up
251 const EXCEPTION_IS_NULL_POINTER = 0x001;
252 const EXCEPTION_IS_NO_OBJECT = 0x002;
253 const EXCEPTION_IS_NO_ARRAY = 0x003;
254 const EXCEPTION_MISSING_METHOD = 0x004;
255 const EXCEPTION_CLASSES_NOT_MATCHING = 0x005;
256 const EXCEPTION_INDEX_OUT_OF_BOUNDS = 0x006;
257 const EXCEPTION_DIMENSION_ARRAY_INVALID = 0x007;
258 const EXCEPTION_ITEM_NOT_TRADEABLE = 0x008;
259 const EXCEPTION_ITEM_NOT_IN_PRICE_LIST = 0x009;
260 const EXCEPTION_GENDER_IS_WRONG = 0x00a;
261 const EXCEPTION_BIRTH_DATE_IS_INVALID = 0x00b;
262 const EXCEPTION_EMPTY_STRUCTURES_ARRAY = 0x00c;
263 const EXCEPTION_HAS_ALREADY_PERSONELL_LIST = 0x00d;
264 const EXCEPTION_NOT_ENOUGTH_UNEMPLOYEES = 0x00e;
265 const EXCEPTION_TOTAL_PRICE_NOT_CALCULATED = 0x00f;
266 const EXCEPTION_HARBOR_HAS_NO_SHIPYARDS = 0x010;
267 const EXCEPTION_CONTRACT_PARTNER_INVALID = 0x011;
268 const EXCEPTION_CONTRACT_PARTNER_MISMATCH = 0x012;
269 const EXCEPTION_CONTRACT_ALREADY_SIGNED = 0x013;
270 const EXCEPTION_UNEXPECTED_EMPTY_STRING = 0x014;
271 const EXCEPTION_PATH_NOT_FOUND = 0x015;
272 const EXCEPTION_INVALID_PATH_NAME = 0x016;
273 const EXCEPTION_READ_PROTECED_PATH = 0x017;
274 const EXCEPTION_WRITE_PROTECED_PATH = 0x018;
275 const EXCEPTION_DIR_POINTER_INVALID = 0x019;
276 const EXCEPTION_FILE_POINTER_INVALID = 0x01a;
277 const EXCEPTION_INVALID_RESOURCE = 0x01b;
278 const EXCEPTION_UNEXPECTED_OBJECT = 0x01c;
279 const EXCEPTION_LIMIT_ELEMENT_IS_UNSUPPORTED = 0x01d;
280 const EXCEPTION_GETTER_IS_MISSING = 0x01e;
281 const EXCEPTION_ARRAY_EXPECTED = 0x01f;
282 const EXCEPTION_ARRAY_HAS_INVALID_COUNT = 0x020;
283 const EXCEPTION_ID_IS_INVALID_FORMAT = 0x021;
284 const EXCEPTION_MD5_CHECKSUMS_MISMATCH = 0x022;
285 const EXCEPTION_UNEXPECTED_STRING_SIZE = 0x023;
286 const EXCEPTION_SIMULATOR_ID_INVALID = 0x024;
287 const EXCEPTION_MISMATCHING_COMPRESSORS = 0x025;
288 const EXCEPTION_CONTAINER_ITEM_IS_NULL = 0x026;
289 const EXCEPTION_ITEM_IS_NO_ARRAY = 0x027;
290 const EXCEPTION_CONTAINER_MAYBE_DAMAGED = 0x028;
291 const EXCEPTION_INVALID_STRING = 0x029;
292 const EXCEPTION_VARIABLE_NOT_SET = 0x02a;
293 const EXCEPTION_ATTRIBUTES_ARE_MISSING = 0x02b;
294 const EXCEPTION_ARRAY_ELEMENTS_MISSING = 0x02c;
295 const EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED = 0x02d;
296 const EXCEPTION_UNSPPORTED_OPERATION = 0x02e;
297 const EXCEPTION_FACTORY_REQUIRE_PARAMETER = 0x02f;
298 const EXCEPTION_MISSING_ELEMENT = 0x030;
299 const EXCEPTION_HEADERS_ALREADY_SENT = 0x031;
300 const EXCEPTION_DEFAULT_CONTROLLER_GONE = 0x032;
301 const EXCEPTION_CLASS_NOT_FOUND = 0x033;
302 const EXCEPTION_REQUIRED_INTERFACE_MISSING = 0x034;
303 const EXCEPTION_FATAL_ERROR = 0x035;
304 const EXCEPTION_FILE_NOT_FOUND = 0x036;
305 const EXCEPTION_ASSERTION_FAILED = 0x037;
306 const EXCEPTION_FILE_CANNOT_BE_READ = 0x038;
307 const EXCEPTION_DATABASE_UPDATED_NOT_ALLOWED = 0x039;
308 const EXCEPTION_FILTER_CHAIN_INTERCEPTED = 0x03a;
311 * Hexadecimal->Decimal translation array
313 private static $hexdec = array(
333 * Decimal->hexadecimal translation array
335 private static $dechex = array(
355 * Startup time in miliseconds
357 private static $startupTime = 0;
360 * Protected super constructor
362 * @param $className Name of the class
365 protected function __construct ($className) {
367 $this->setRealClass($className);
369 // Set configuration instance if no registry ...
370 if (!$this instanceof Register) {
371 // ... because registries doesn't need to be configured
372 $this->setConfigInstance(FrameworkConfiguration::getSelfInstance());
375 // Is the startup time set? (0 cannot be TRUE anymore)
376 if (self::$startupTime == 0) {
378 self::$startupTime = microtime(TRUE);
383 * Destructor for all classes
387 public function __destruct () {
388 // Flush any updated entries to the database
389 $this->flushPendingUpdates();
391 // Is this object already destroyed?
392 if ($this->__toString() != 'DestructedObject') {
393 // Destroy all informations about this class but keep some text about it alive
394 $this->setRealClass('DestructedObject');
395 } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
396 // Already destructed object
397 self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:] The object <span class="object_name">%s</span> is already destroyed.',
402 // Do not call this twice
403 trigger_error(__METHOD__ . ': Called twice.');
409 * The __call() method where all non-implemented methods end up
411 * @param $methodName Name of the missing method
412 * @args $args Arguments passed to the method
415 public final function __call ($methodName, $args) {
416 return self::__callStatic($methodName, $args);
420 * The __callStatic() method where all non-implemented static methods end up
422 * @param $methodName Name of the missing method
423 * @args $args Arguments passed to the method
426 public static final function __callStatic ($methodName, $args) {
427 // Init argument string
430 // Is it empty or an array?
433 $argsString = 'NULL';
434 } elseif (is_array($args)) {
435 // Some arguments are there
436 foreach ($args as $arg) {
437 // Add the value itself if not array. This prevents 'array to string conversion' message
438 if (is_array($arg)) {
439 $argsString .= 'Array';
444 // Add data about the argument
445 $argsString .= ' (' . gettype($arg);
447 if (is_string($arg)) {
448 // Add length for strings
449 $argsString .= ', ' . strlen($arg);
450 } elseif (is_array($arg)) {
451 // .. or size if array
452 $argsString .= ', ' . count($arg);
453 } elseif ($arg === TRUE) {
454 // ... is boolean 'TRUE'
455 $argsString .= ', TRUE';
456 } elseif ($arg === FALSE) {
457 // ... is boolean 'FALSE'
458 $argsString .= ', FALSE';
462 $argsString .= '), ';
466 if (substr($argsString, -2, 1) == ',') {
467 $argsString = substr($argsString, 0, -2);
470 // Invalid arguments!
471 $argsString = '!INVALID:' . gettype($args) . '!';
474 // Output stub message
475 // @TODO __CLASS__ does always return BaseFrameworkSystem but not the extending (=child) class
476 self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[unknown::%s:] Stub! Args: %s',
486 * Getter for $realClass
488 * @return $realClass The name of the real class (not BaseFrameworkSystem)
490 public function __toString () {
491 return $this->realClass;
495 * Magic function to catch setting of missing but set class fields/attributes
497 * @param $name Name of the field/attribute
498 * @param $value Value to store
501 public final function __set ($name, $value) {
502 $this->debugBackTrace(sprintf('Tried to set a missing field. name=%s, value[%s]=%s',
505 print_r($value, TRUE)
510 * Magic function to catch getting of missing fields/attributes
512 * @param $name Name of the field/attribute
515 public final function __get ($name) {
516 $this->debugBackTrace(sprintf('Tried to get a missing field. name=%s',
522 * Magic function to catch unsetting of missing fields/attributes
524 * @param $name Name of the field/attribute
527 public final function __unset ($name) {
528 $this->debugBackTrace(sprintf('Tried to unset a missing field. name=%s',
534 * Setter for the real class name
536 * @param $realClass Class name (string)
539 public final function setRealClass ($realClass) {
541 $this->realClass = (string) $realClass;
545 * Setter for database result instance
547 * @param $resultInstance An instance of a database result class
549 * @todo SearchableResult and UpdateableResult shall have a super interface to use here
551 protected final function setResultInstance (SearchableResult $resultInstance) {
552 $this->resultInstance = $resultInstance;
556 * Getter for database result instance
558 * @return $resultInstance An instance of a database result class
560 public final function getResultInstance () {
561 return $this->resultInstance;
565 * Setter for template engine instances
567 * @param $templateInstance An instance of a template engine class
570 protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
571 $this->templateInstance = $templateInstance;
575 * Getter for template engine instances
577 * @return $templateInstance An instance of a template engine class
579 protected final function getTemplateInstance () {
580 return $this->templateInstance;
584 * Setter for search instance
586 * @param $searchInstance Searchable criteria instance
589 public final function setSearchInstance (LocalSearchCriteria $searchInstance) {
590 $this->searchInstance = $searchInstance;
594 * Getter for search instance
596 * @return $searchInstance Searchable criteria instance
598 public final function getSearchInstance () {
599 return $this->searchInstance;
603 * Setter for update instance
605 * @param $updateInstance Searchable criteria instance
608 public final function setUpdateInstance (LocalUpdateCriteria $updateInstance) {
609 $this->updateInstance = $updateInstance;
613 * Getter for update instance
615 * @return $updateInstance Updateable criteria instance
617 public final function getUpdateInstance () {
618 return $this->updateInstance;
622 * Setter for resolver instance
624 * @param $resolverInstance Instance of a command resolver class
627 public final function setResolverInstance (Resolver $resolverInstance) {
628 $this->resolverInstance = $resolverInstance;
632 * Getter for resolver instance
634 * @return $resolverInstance Instance of a command resolver class
636 public final function getResolverInstance () {
637 return $this->resolverInstance;
641 * Setter for language instance
643 * @param $configInstance The configuration instance which shall
644 * be FrameworkConfiguration
647 public final function setConfigInstance (FrameworkConfiguration $configInstance) {
648 Registry::getRegistry()->addInstance('config', $configInstance);
652 * Getter for configuration instance
654 * @return $configInstance Configuration instance
656 public final function getConfigInstance () {
657 $configInstance = Registry::getRegistry()->getInstance('config');
658 return $configInstance;
662 * Setter for debug instance
664 * @param $debugInstance The instance for debug output class
667 public final function setDebugInstance (DebugMiddleware $debugInstance) {
668 Registry::getRegistry()->addInstance('debug', $debugInstance);
672 * Getter for debug instance
674 * @return $debugInstance Instance to class DebugConsoleOutput or DebugWebOutput
676 public final function getDebugInstance () {
677 // Get debug instance
678 $debugInstance = Registry::getRegistry()->getInstance('debug');
681 return $debugInstance;
685 * Setter for web output instance
687 * @param $webInstance The instance for web output class
690 public final function setWebOutputInstance (OutputStreamer $webInstance) {
691 Registry::getRegistry()->addInstance('web_output', $webInstance);
695 * Getter for web output instance
697 * @return $webOutputInstance - Instance to class WebOutput
699 public final function getWebOutputInstance () {
700 $webOutputInstance = Registry::getRegistry()->getInstance('web_output');
701 return $webOutputInstance;
705 * Setter for database instance
707 * @param $databaseInstance The instance for the database connection (forced DatabaseConnection)
710 public final function setDatabaseInstance (DatabaseConnection $databaseInstance) {
711 Registry::getRegistry()->addInstance('db_instance', $databaseInstance);
715 * Getter for database layer
717 * @return $databaseInstance The database layer instance
719 public final function getDatabaseInstance () {
721 $databaseInstance = Registry::getRegistry()->getInstance('db_instance');
724 return $databaseInstance;
728 * Setter for compressor channel
730 * @param $compressorInstance An instance of CompressorChannel
733 public final function setCompressorChannel (CompressorChannel $compressorInstance) {
734 Registry::getRegistry()->addInstance('compressor', $compressorInstance);
738 * Getter for compressor channel
740 * @return $compressorInstance The compressor channel
742 public final function getCompressorChannel () {
743 $compressorInstance = Registry::getRegistry()->getInstance('compressor');
744 return $compressorInstance;
748 * Protected getter for a manageable application helper class
750 * @return $applicationInstance An instance of a manageable application helper class
752 protected final function getApplicationInstance () {
753 $applicationInstance = Registry::getRegistry()->getInstance('application');
754 return $applicationInstance;
758 * Setter for a manageable application helper class
760 * @param $applicationInstance An instance of a manageable application helper class
763 public final function setApplicationInstance (ManageableApplication $applicationInstance) {
764 Registry::getRegistry()->addInstance('application', $applicationInstance);
768 * Setter for request instance
770 * @param $requestInstance An instance of a Requestable class
773 public final function setRequestInstance (Requestable $requestInstance) {
774 $this->requestInstance = $requestInstance;
778 * Getter for request instance
780 * @return $requestInstance An instance of a Requestable class
782 public final function getRequestInstance () {
783 return $this->requestInstance;
787 * Setter for response instance
789 * @param $responseInstance An instance of a Responseable class
792 public final function setResponseInstance (Responseable $responseInstance) {
793 $this->responseInstance = $responseInstance;
797 * Getter for response instance
799 * @return $responseInstance An instance of a Responseable class
801 public final function getResponseInstance () {
802 return $this->responseInstance;
806 * Private getter for language instance
808 * @return $langInstance An instance to the language sub-system
810 protected final function getLanguageInstance () {
811 $langInstance = Registry::getRegistry()->getInstance('language');
812 return $langInstance;
816 * Setter for language instance
818 * @param $langInstance An instance to the language sub-system
820 * @see LanguageSystem
822 public final function setLanguageInstance (ManageableLanguage $langInstance) {
823 Registry::getRegistry()->addInstance('language', $langInstance);
827 * Private getter for file IO instance
829 * @return $fileIoInstance An instance to the file I/O sub-system
831 protected final function getFileIoInstance () {
832 return $this->fileIoInstance;
836 * Setter for file I/O instance
838 * @param $fileIoInstance An instance to the file I/O sub-system
841 public final function setFileIoInstance (IoHandler $fileIoInstance) {
842 $this->fileIoInstance = $fileIoInstance;
846 * Protected setter for user instance
848 * @param $userInstance An instance of a user class
851 protected final function setUserInstance (ManageableAccount $userInstance) {
852 $this->userInstance = $userInstance;
856 * Getter for user instance
858 * @return $userInstance An instance of a user class
860 public final function getUserInstance () {
861 return $this->userInstance;
865 * Setter for controller instance (this surely breaks a bit the MVC patterm)
867 * @param $controllerInstance An instance of the controller
870 public final function setControllerInstance (Controller $controllerInstance) {
871 $this->controllerInstance = $controllerInstance;
875 * Getter for controller instance (this surely breaks a bit the MVC patterm)
877 * @return $controllerInstance An instance of the controller
879 public final function getControllerInstance () {
880 return $this->controllerInstance;
884 * Setter for RNG instance
886 * @param $rngInstance An instance of a random number generator (RNG)
889 protected final function setRngInstance (RandomNumberGenerator $rngInstance) {
890 $this->rngInstance = $rngInstance;
894 * Getter for RNG instance
896 * @return $rngInstance An instance of a random number generator (RNG)
898 public final function getRngInstance () {
899 return $this->rngInstance;
903 * Setter for Cryptable instance
905 * @param $cryptoInstance An instance of a Cryptable class
908 protected final function setCryptoInstance (Cryptable $cryptoInstance) {
909 $this->cryptoInstance = $cryptoInstance;
913 * Getter for Cryptable instance
915 * @return $cryptoInstance An instance of a Cryptable class
917 public final function getCryptoInstance () {
918 return $this->cryptoInstance;
922 * Setter for the list instance
924 * @param $listInstance A list of Listable
927 protected final function setListInstance (Listable $listInstance) {
928 $this->listInstance = $listInstance;
932 * Getter for the list instance
934 * @return $listInstance A list of Listable
936 protected final function getListInstance () {
937 return $this->listInstance;
941 * Setter for the menu instance
943 * @param $menuInstance A RenderableMenu instance
946 protected final function setMenuInstance (RenderableMenu $menuInstance) {
947 $this->menuInstance = $menuInstance;
951 * Getter for the menu instance
953 * @return $menuInstance A RenderableMenu instance
955 protected final function getMenuInstance () {
956 return $this->menuInstance;
960 * Setter for image instance
962 * @param $imageInstance An instance of an image
965 public final function setImageInstance (BaseImage $imageInstance) {
966 $this->imageInstance = $imageInstance;
970 * Getter for image instance
972 * @return $imageInstance An instance of an image
974 public final function getImageInstance () {
975 return $this->imageInstance;
979 * Setter for stacker instance
981 * @param $stackInstance An instance of an stacker
984 public final function setStackInstance (Stackable $stackInstance) {
985 $this->stackInstance = $stackInstance;
989 * Getter for stacker instance
991 * @return $stackInstance An instance of an stacker
993 public final function getStackInstance () {
994 return $this->stackInstance;
998 * Setter for compressor instance
1000 * @param $compressorInstance An instance of an compressor
1003 public final function setCompressorInstance (Compressor $compressorInstance) {
1004 $this->compressorInstance = $compressorInstance;
1008 * Getter for compressor instance
1010 * @return $compressorInstance An instance of an compressor
1012 public final function getCompressorInstance () {
1013 return $this->compressorInstance;
1017 * Setter for Parseable instance
1019 * @param $parserInstance An instance of an Parseable
1022 public final function setParserInstance (Parseable $parserInstance) {
1023 $this->parserInstance = $parserInstance;
1027 * Getter for Parseable instance
1029 * @return $parserInstance An instance of an Parseable
1031 public final function getParserInstance () {
1032 return $this->parserInstance;
1036 * Setter for HandleableProtocol instance
1038 * @param $protocolInstance An instance of an HandleableProtocol
1041 public final function setProtocolInstance (HandleableProtocol $protocolInstance) {
1042 $this->protocolInstance = $protocolInstance;
1046 * Getter for HandleableProtocol instance
1048 * @return $protocolInstance An instance of an HandleableProtocol
1050 public final function getProtocolInstance () {
1051 return $this->protocolInstance;
1055 * Setter for DatabaseWrapper instance
1057 * @param $wrapperInstance An instance of an DatabaseWrapper
1060 public final function setWrapperInstance (DatabaseWrapper $wrapperInstance) {
1061 $this->wrapperInstance = $wrapperInstance;
1065 * Getter for DatabaseWrapper instance
1067 * @return $wrapperInstance An instance of an DatabaseWrapper
1069 public final function getWrapperInstance () {
1070 return $this->wrapperInstance;
1074 * Setter for socket resource
1076 * @param $socketResource A valid socket resource
1079 public final function setSocketResource ($socketResource) {
1080 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': socketResource=' . $socketResource . ',previous[' . gettype($this->socketResource) . ']=' . $this->socketResource);
1081 $this->socketResource = $socketResource;
1085 * Getter for socket resource
1087 * @return $socketResource A valid socket resource
1089 public final function getSocketResource () {
1090 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': socketResource[' . gettype($this->socketResource) . ']=' . $this->socketResource);
1091 return $this->socketResource;
1095 * Setter for regular expression
1097 * @param $regularExpression A valid regular expression
1100 public final function setRegularExpression ($regularExpression) {
1101 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': regularExpression=' . $regularExpression . ',previous[' . gettype($this->regularExpression) . ']=' . $this->regularExpression);
1102 $this->regularExpression = $regularExpression;
1106 * Getter for regular expression
1108 * @return $regularExpression A valid regular expression
1110 public final function getRegularExpression () {
1111 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': regularExpression[' . gettype($this->regularExpression) . ']=' . $this->regularExpression);
1112 return $this->regularExpression;
1116 * Setter for helper instance
1118 * @param $helperInstance An instance of a helper class
1121 protected final function setHelperInstance (Helper $helperInstance) {
1122 $this->helperInstance = $helperInstance;
1126 * Getter for helper instance
1128 * @return $helperInstance An instance of a helper class
1130 public final function getHelperInstance () {
1131 return $this->helperInstance;
1135 * Setter for a Sourceable instance
1137 * @param $sourceInstance An instance of a Sourceable class
1140 protected final function setSourceInstance (Sourceable $sourceInstance) {
1141 $this->sourceInstance = $sourceInstance;
1145 * Getter for a Sourceable instance
1147 * @return $sourceInstance An instance of a Sourceable class
1149 protected final function getSourceInstance () {
1150 return $this->sourceInstance;
1154 * Setter for a UrlSource instance
1156 * @param $sourceInstance An instance of a UrlSource class
1159 protected final function setUrlSourceInstance (UrlSource $urlSourceInstance) {
1160 $this->urlSourceInstance = $urlSourceInstance;
1164 * Getter for a UrlSource instance
1166 * @return $urlSourceInstance An instance of a UrlSource class
1168 protected final function getUrlSourceInstance () {
1169 return $this->urlSourceInstance;
1173 * Getter for a InputStream instance
1175 * @param $inputStreamInstance The InputStream instance
1177 protected final function getInputStreamInstance () {
1178 return $this->inputStreamInstance;
1182 * Setter for a InputStream instance
1184 * @param $inputStreamInstance The InputStream instance
1187 protected final function setInputStreamInstance (InputStream $inputStreamInstance) {
1188 $this->inputStreamInstance = $inputStreamInstance;
1192 * Getter for a OutputStream instance
1194 * @param $outputStreamInstance The OutputStream instance
1196 protected final function getOutputStreamInstance () {
1197 return $this->outputStreamInstance;
1201 * Setter for a OutputStream instance
1203 * @param $outputStreamInstance The OutputStream instance
1206 protected final function setOutputStreamInstance (OutputStream $outputStreamInstance) {
1207 $this->outputStreamInstance = $outputStreamInstance;
1211 * Setter for handler instance
1213 * @param $handlerInstance An instance of a Handleable class
1216 protected final function setHandlerInstance (Handleable $handlerInstance) {
1217 $this->handlerInstance = $handlerInstance;
1221 * Getter for handler instance
1223 * @return $handlerInstance A Networkable instance
1225 protected final function getHandlerInstance () {
1226 return $this->handlerInstance;
1230 * Setter for visitor instance
1232 * @param $visitorInstance A Visitor instance
1235 protected final function setVisitorInstance (Visitor $visitorInstance) {
1236 $this->visitorInstance = $visitorInstance;
1240 * Getter for visitor instance
1242 * @return $visitorInstance A Visitor instance
1244 protected final function getVisitorInstance () {
1245 return $this->visitorInstance;
1249 * Setter for DHT instance
1251 * @param $dhtInstance A Distributable instance
1254 protected final function setDhtInstance (Distributable $dhtInstance) {
1255 $this->dhtInstance = $dhtInstance;
1259 * Getter for DHT instance
1261 * @return $dhtInstance A Distributable instance
1263 protected final function getDhtInstance () {
1264 return $this->dhtInstance;
1268 * Setter for raw package Data
1270 * @param $packageData Raw package Data
1273 public final function setPackageData (array $packageData) {
1274 $this->packageData = $packageData;
1278 * Getter for raw package Data
1280 * @return $packageData Raw package Data
1282 public function getPackageData () {
1283 return $this->packageData;
1288 * Setter for Iterator instance
1290 * @param $iteratorInstance An instance of an Iterator
1293 protected final function setIteratorInstance (Iterator $iteratorInstance) {
1294 $this->iteratorInstance = $iteratorInstance;
1298 * Getter for Iterator instance
1300 * @return $iteratorInstance An instance of an Iterator
1302 public final function getIteratorInstance () {
1303 return $this->iteratorInstance;
1307 * Setter for FilePointer instance
1309 * @param $pointerInstance An instance of an FilePointer class
1312 protected final function setPointerInstance (FilePointer $pointerInstance) {
1313 $this->pointerInstance = $pointerInstance;
1317 * Getter for FilePointer instance
1319 * @return $pointerInstance An instance of an FilePointer class
1321 public final function getPointerInstance () {
1322 return $this->pointerInstance;
1326 * Unsets pointer instance which triggers a call of __destruct() if the
1327 * instance is still there. This is surely not fatal on already "closed"
1328 * file pointer instances.
1330 * I don't want to mess around with above setter by giving it a default
1331 * value NULL as setter should always explicitly only set (existing) object
1332 * instances and NULL is NULL.
1336 protected final function unsetPointerInstance () {
1337 // Simply it to NULL
1338 $this->pointerInstance = NULL;
1342 * Setter for Indexable instance
1344 * @param $indexInstance An instance of an Indexable class
1347 protected final function setIndexInstance (Indexable $indexInstance) {
1348 $this->indexInstance = $indexInstance;
1352 * Getter for Indexable instance
1354 * @return $indexInstance An instance of an Indexable class
1356 public final function getIndexInstance () {
1357 return $this->indexInstance;
1361 * Setter for Block instance
1363 * @param $blockInstance An instance of an Block class
1366 protected final function setBlockInstance (Block $blockInstance) {
1367 $this->blockInstance = $blockInstance;
1371 * Getter for Block instance
1373 * @return $blockInstance An instance of an Block class
1375 public final function getBlockInstance () {
1376 return $this->blockInstance;
1380 * Setter for Minable instance
1382 * @param $minableInstance A Minable instance
1385 protected final function setMinableInstance (Minable $minableInstance) {
1386 $this->minableInstance = $minableInstance;
1390 * Getter for minable instance
1392 * @return $minableInstance A Minable instance
1394 protected final function getMinableInstance () {
1395 return $this->minableInstance;
1399 * Setter for FrameworkDirectory instance
1401 * @param $directoryInstance A FrameworkDirectoryPointer instance
1404 protected final function setDirectoryInstance (FrameworkDirectory $directoryInstance) {
1405 $this->directoryInstance = $directoryInstance;
1409 * Getter for FrameworkDirectory instance
1411 * @return $directoryInstance A FrameworkDirectory instance
1413 protected final function getDirectoryInstance () {
1414 return $this->directoryInstance;
1418 * Setter for listener instance
1420 * @param $listenerInstance A Listenable instance
1423 protected final function setListenerInstance (Listenable $listenerInstance) {
1424 $this->listenerInstance = $listenerInstance;
1428 * Getter for listener instance
1430 * @return $listenerInstance A Listenable instance
1432 protected final function getListenerInstance () {
1433 return $this->listenerInstance;
1437 * Checks whether an object equals this object. You should overwrite this
1438 * method to implement own equality checks
1440 * @param $objectInstance An instance of a FrameworkInterface object
1441 * @return $equals Whether both objects equals
1443 public function equals (FrameworkInterface $objectInstance) {
1446 $this->__toString() == $objectInstance->__toString()
1448 $this->hashCode() == $objectInstance->hashCode()
1451 // Return the result
1456 * Generates a generic hash code of this class. You should really overwrite
1457 * this method with your own hash code generator code. But keep KISS in mind.
1459 * @return $hashCode A generic hash code respresenting this whole class
1461 public function hashCode () {
1463 return crc32($this->__toString());
1467 * Formats computer generated price values into human-understandable formats
1468 * with thousand and decimal separators.
1470 * @param $value The in computer format value for a price
1471 * @param $currency The currency symbol (use HTML-valid characters!)
1472 * @param $decNum Number of decimals after commata
1473 * @return $price The for the current language formated price string
1474 * @throws MissingDecimalsThousandsSeparatorException If decimals or
1475 * thousands separator
1478 public function formatCurrency ($value, $currency = '€', $decNum = 2) {
1479 // Are all required attriutes set?
1480 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
1481 // Throw an exception
1482 throw new MissingDecimalsThousandsSeparatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
1486 $value = (float) $value;
1488 // Reformat the US number
1489 $price = number_format($value, $decNum, $this->decimals, $this->thousands) . $currency;
1491 // Return as string...
1496 * Appends a trailing slash to a string
1498 * @param $str A string (maybe) without trailing slash
1499 * @return $str A string with an auto-appended trailing slash
1501 public final function addMissingTrailingSlash ($str) {
1502 // Is there a trailing slash?
1503 if (substr($str, -1, 1) != '/') {
1507 // Return string with trailing slash
1512 * Prepare the template engine (WebTemplateEngine by default) for a given
1513 * application helper instance (ApplicationHelper by default).
1515 * @param $applicationInstance An application helper instance or
1516 * null if we shall use the default
1517 * @return $templateInstance The template engine instance
1518 * @throws NullPointerException If the discovered application
1519 * instance is still null
1521 protected function prepareTemplateInstance (ManageableApplication $applicationInstance = NULL) {
1522 // Is the application instance set?
1523 if (is_null($applicationInstance)) {
1524 // Get the current instance
1525 $applicationInstance = $this->getApplicationInstance();
1528 if (is_null($applicationInstance)) {
1529 // Thrown an exception
1530 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1534 // Initialize the template engine
1535 $templateInstance = ObjectFactory::createObjectByConfiguredName('web_template_class');
1537 // Return the prepared instance
1538 return $templateInstance;
1542 * Debugs this instance by putting out it's full content
1544 * @param $message Optional message to show in debug output
1547 public final function debugInstance ($message = '') {
1548 // Restore the error handler to avoid trouble with missing array elements or undeclared variables
1549 restore_error_handler();
1554 // Is a message set?
1555 if (!empty($message)) {
1556 // Construct message
1557 $content = sprintf('<div class="debug_message">Message: %s</div>' . PHP_EOL, $message);
1560 // Generate the output
1561 $content .= sprintf('<pre>%s</pre>',
1564 print_r($this, TRUE)
1570 ApplicationEntryPoint::app_exit(sprintf('<div class="debug_header">%s debug output:</div><div class="debug_content">%s</div>Loaded includes: <div class="debug_include_list">%s</div>',
1571 $this->__toString(),
1573 ClassLoader::getSelfInstance()->getPrintableIncludeList()
1578 * Replaces control characters with printable output
1580 * @param $str String with control characters
1581 * @return $str Replaced string
1583 protected function replaceControlCharacters ($str) {
1586 chr(13), '[r]', str_replace(
1587 chr(10), '[n]', str_replace(
1597 * Output a partial stub message for the caller method
1599 * @param $message An optional message to display
1602 protected function partialStub ($message = '') {
1603 // Get the backtrace
1604 $backtrace = debug_backtrace();
1606 // Generate the class::method string
1607 $methodName = 'UnknownClass->unknownMethod';
1608 if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
1609 $methodName = $backtrace[1]['class'] . '->' . $backtrace[1]['function'];
1612 // Construct the full message
1613 $stubMessage = sprintf('[%s:] Partial stub!',
1617 // Is the extra message given?
1618 if (!empty($message)) {
1619 // Then add it as well
1620 $stubMessage .= ' Message: ' . $message;
1623 // Debug instance is there?
1624 if (!is_null($this->getDebugInstance())) {
1625 // Output stub message
1626 self::createDebugInstance(__CLASS__)->debugOutput($stubMessage);
1629 trigger_error($stubMessage);
1635 * Outputs a debug backtrace and stops further script execution
1637 * @param $message An optional message to output
1638 * @param $doExit Whether exit the program (TRUE is default)
1641 public function debugBackTrace ($message = '', $doExit = TRUE) {
1642 // Sorry, there is no other way getting this nice backtrace
1643 if (!empty($message)) {
1645 printf('Message: %s<br />' . chr(10), $message);
1649 debug_print_backtrace();
1653 if ($doExit === TRUE) {
1659 * Creates an instance of a debugger instance
1661 * @param $className Name of the class (currently unsupported)
1662 * @return $debugInstance An instance of a debugger class
1664 public final static function createDebugInstance ($className) {
1665 // Is the instance set?
1666 if (!Registry::getRegistry()->instanceExists('debug')) {
1667 // Init debug instance
1668 $debugInstance = NULL;
1672 // Get a debugger instance
1673 $debugInstance = DebugMiddleware::createDebugMiddleware(FrameworkConfiguration::getSelfInstance()->getConfigEntry('debug_class'));
1674 } catch (NullPointerException $e) {
1675 // Didn't work, no instance there
1676 exit('Cannot create debugInstance! Exception=' . $e->__toString() . ', message=' . $e->getMessage());
1679 // Empty string should be ignored and used for testing the middleware
1680 DebugMiddleware::getSelfInstance()->output('');
1682 // Set it in its own class. This will set it in the registry
1683 $debugInstance->setDebugInstance($debugInstance);
1685 // Get instance from registry
1686 $debugInstance = Registry::getRegistry()->getDebugInstance();
1690 return $debugInstance;
1694 * Simple output of a message with line-break
1696 * @param $message Message to output
1699 public function outputLine ($message) {
1701 print($message . PHP_EOL);
1705 * Outputs a debug message whether to debug instance (should be set!) or
1706 * dies with or ptints the message. Do NEVER EVER rewrite the exit() call to
1707 * ApplicationEntryPoint::app_exit(), this would cause an endless loop.
1709 * @param $message Message we shall send out...
1710 * @param $doPrint Whether print or die here (default: print)
1711 * @paran $stripTags Whether to strip tags (default: FALSE)
1714 public function debugOutput ($message, $doPrint = TRUE, $stripTags = FALSE) {
1715 // Set debug instance to NULL
1716 $debugInstance = NULL;
1720 // Get debug instance
1721 $debugInstance = $this->getDebugInstance();
1722 } catch (NullPointerException $e) {
1723 // The debug instance is not set (yet)
1726 // Is the debug instance there?
1727 if (is_object($debugInstance)) {
1728 // Use debug output handler
1729 $debugInstance->output($message, $stripTags);
1731 if ($doPrint === FALSE) {
1732 // Die here if not printed
1736 // Are debug times enabled?
1737 if ($this->getConfigInstance()->getConfigEntry('debug_output_timings') == 'Y') {
1739 $message = $this->getPrintableExecutionTime() . $message;
1743 if ($doPrint === TRUE) {
1745 $this->outputLine($message);
1754 * Converts e.g. a command from URL to a valid class by keeping out bad characters
1756 * @param $str The string, what ever it is needs to be converted
1757 * @return $className Generated class name
1759 public function convertToClassName ($str) {
1763 // Convert all dashes in underscores
1764 $str = $this->convertDashesToUnderscores($str);
1766 // Now use that underscores to get classname parts for hungarian style
1767 foreach (explode('_', $str) as $strPart) {
1768 // Make the class name part lower case and first upper case
1769 $className .= ucfirst(strtolower($strPart));
1772 // Return class name
1777 * Converts dashes to underscores, e.g. useable for configuration entries
1779 * @param $str The string with maybe dashes inside
1780 * @return $str The converted string with no dashed, but underscores
1782 public final function convertDashesToUnderscores ($str) {
1784 $str = str_replace('-', '_', $str);
1786 // Return converted string
1791 * Marks up the code by adding e.g. line numbers
1793 * @param $phpCode Unmarked PHP code
1794 * @return $markedCode Marked PHP code
1796 public function markupCode ($phpCode) {
1801 $errorArray = error_get_last();
1803 // Init the code with error message
1804 if (is_array($errorArray)) {
1806 $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>',
1807 basename($errorArray['file']),
1808 $errorArray['line'],
1809 $errorArray['message'],
1814 // Add line number to the code
1815 foreach (explode(chr(10), $phpCode) as $lineNo => $code) {
1817 $markedCode .= sprintf('<span id="code_line">%s</span>: %s' . chr(10),
1819 htmlentities($code, ENT_QUOTES)
1828 * Filter a given GMT timestamp (non Uni* stamp!) to make it look more
1829 * beatiful for web-based front-ends. If null is given a message id
1830 * null_timestamp will be resolved and returned.
1832 * @param $timestamp Timestamp to prepare (filter) for display
1833 * @return $readable A readable timestamp
1835 public function doFilterFormatTimestamp ($timestamp) {
1836 // Default value to return
1839 // Is the timestamp null?
1840 if (is_null($timestamp)) {
1841 // Get a message string
1842 $readable = $this->getLanguageInstance()->getMessage('null_timestamp');
1844 switch ($this->getLanguageInstance()->getLanguageCode()) {
1845 case 'de': // German format is a bit different to default
1846 // Split the GMT stamp up
1847 $dateTime = explode(' ', $timestamp );
1848 $dateArray = explode('-', $dateTime[0]);
1849 $timeArray = explode(':', $dateTime[1]);
1851 // Construct the timestamp
1852 $readable = sprintf($this->getConfigInstance()->getConfigEntry('german_date_time'),
1862 default: // Default is pass-through
1863 $readable = $timestamp;
1873 * Filter a given number into a localized number
1875 * @param $value The raw value from e.g. database
1876 * @return $localized Localized value
1878 public function doFilterFormatNumber ($value) {
1879 // Generate it from config and localize dependencies
1880 switch ($this->getLanguageInstance()->getLanguageCode()) {
1881 case 'de': // German format is a bit different to default
1882 $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), ',', '.');
1885 default: // US, etc.
1886 $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), '.', ',');
1895 * "Getter" for databse entry
1897 * @return $entry An array with database entries
1898 * @throws NullPointerException If the database result is not found
1899 * @throws InvalidDatabaseResultException If the database result is invalid
1901 protected final function getDatabaseEntry () {
1902 // Is there an instance?
1903 if (is_null($this->getResultInstance())) {
1904 // Throw an exception here
1905 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1909 $this->getResultInstance()->rewind();
1911 // Do we have an entry?
1912 if ($this->getResultInstance()->valid() === FALSE) {
1913 // @TODO Move the constant to e.g. BaseDatabaseResult when there is a non-cached database result available
1914 throw new InvalidDatabaseResultException(array($this, $this->getResultInstance()), CachedDatabaseResult::EXCEPTION_INVALID_DATABASE_RESULT);
1918 $this->getResultInstance()->next();
1921 $entry = $this->getResultInstance()->current();
1928 * Getter for field name
1930 * @param $fieldName Field name which we shall get
1931 * @return $fieldValue Field value from the user
1932 * @throws NullPointerException If the result instance is null
1934 public final function getField ($fieldName) {
1935 // Default field value
1938 // Get result instance
1939 $resultInstance = $this->getResultInstance();
1941 // Is this instance null?
1942 if (is_null($resultInstance)) {
1943 // Then the user instance is no longer valid (expired cookies?)
1944 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1947 // Get current array
1948 $fieldArray = $resultInstance->current();
1949 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($fieldName.':<pre>'.print_r($fieldArray, TRUE).'</pre>');
1951 // Convert dashes to underscore
1952 $fieldName = $this->convertDashesToUnderscores($fieldName);
1954 // Does the field exist?
1955 if (isset($fieldArray[$fieldName])) {
1957 $fieldValue = $fieldArray[$fieldName];
1959 // Missing field entry, may require debugging
1960 self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']:fieldName=' . $fieldName . ' not found!');
1968 * Flushs all pending updates to the database layer
1972 public function flushPendingUpdates () {
1973 // Get result instance
1974 $resultInstance = $this->getResultInstance();
1976 // Do we have data to update?
1977 if ((is_object($resultInstance)) && ($resultInstance->ifDataNeedsFlush())) {
1978 // Get wrapper class name config entry
1979 $configEntry = $resultInstance->getUpdateInstance()->getWrapperConfigEntry();
1981 // Create object instance
1982 $wrapperInstance = ObjectFactory::createObjectByConfiguredName($configEntry);
1984 // Yes, then send the whole result to the database layer
1985 $wrapperInstance->doUpdateByResult($this->getResultInstance());
1990 * Outputs a deprecation warning to the developer.
1992 * @param $message The message we shall output to the developer
1994 * @todo Write a logging mechanism for productive mode
1996 public function deprecationWarning ($message) {
1997 // Is developer mode active?
1998 if (defined('DEVELOPER')) {
1999 // Debug instance is there?
2000 if (!is_null($this->getDebugInstance())) {
2001 // Output stub message
2002 self::createDebugInstance(__CLASS__)->debugOutput($message);
2005 trigger_error($message . "<br />\n");
2009 // @TODO Finish this part!
2010 $this->partialStub('Developer mode inactive. Message:' . $message);
2015 * Checks whether the given PHP extension is loaded
2017 * @param $phpExtension The PHP extension we shall check
2018 * @return $isLoaded Whether the PHP extension is loaded
2020 public final function isPhpExtensionLoaded ($phpExtension) {
2022 $isLoaded = in_array($phpExtension, get_loaded_extensions());
2029 * "Getter" as a time() replacement but with milliseconds. You should use this
2030 * method instead of the encapsulated getimeofday() function.
2032 * @return $milliTime Timestamp with milliseconds
2034 public function getMilliTime () {
2035 // Get the time of day as float
2036 $milliTime = gettimeofday(TRUE);
2043 * Idles (sleeps) for given milliseconds
2045 * @return $hasSlept Whether it goes fine
2047 public function idle ($milliSeconds) {
2048 // Sleep is fine by default
2051 // Idle so long with found function
2052 if (function_exists('time_sleep_until')) {
2053 // Get current time and add idle time
2054 $sleepUntil = $this->getMilliTime() + abs($milliSeconds) / 1000;
2056 // New PHP 5.1.0 function found, ignore errors
2057 $hasSlept = @time_sleep_until($sleepUntil);
2060 * My Sun station doesn't have that function even with latest PHP
2063 usleep($milliSeconds * 1000);
2070 * Converts a hexadecimal string, even with negative sign as first string to
2071 * a decimal number using BC functions.
2073 * This work is based on comment #86673 on php.net documentation page at:
2074 * <http://de.php.net/manual/en/function.dechex.php#86673>
2076 * @param $hex Hexadecimal string
2077 * @return $dec Decimal number
2079 protected function hex2dec ($hex) {
2080 // Convert to all lower-case
2081 $hex = strtolower($hex);
2083 // Detect sign (negative/positive numbers)
2085 if (substr($hex, 0, 1) == '-') {
2087 $hex = substr($hex, 1);
2090 // Decode the hexadecimal string into a decimal number
2092 for ($i = strlen($hex) - 1, $e = 1; $i >= 0; $i--, $e = bcmul($e, 16)) {
2093 $factor = self::$hexdec[substr($hex, $i, 1)];
2094 $dec = bcadd($dec, bcmul($factor, $e));
2097 // Return the decimal number
2098 return $sign . $dec;
2102 * Converts even very large decimal numbers, also signed, to a hexadecimal
2105 * This work is based on comment #97756 on php.net documentation page at:
2106 * <http://de.php.net/manual/en/function.hexdec.php#97756>
2108 * @param $dec Decimal number, even with negative sign
2109 * @param $maxLength Optional maximum length of the string
2110 * @return $hex Hexadecimal string
2112 protected function dec2hex ($dec, $maxLength = 0) {
2113 // maxLength can be zero or devideable by 2
2114 assert(($maxLength == 0) || (($maxLength % 2) == 0));
2116 // Detect sign (negative/positive numbers)
2123 // Encode the decimal number into a hexadecimal string
2126 $hex = self::$dechex[($dec % (2 ^ 4))] . $hex;
2128 } while ($dec >= 1);
2131 * Leading zeros are required for hex-decimal "numbers". In some
2132 * situations more leading zeros are wanted, so check for both
2135 if ($maxLength > 0) {
2136 // Prepend more zeros
2137 $hex = str_pad($hex, $maxLength, '0', STR_PAD_LEFT);
2138 } elseif ((strlen($hex) % 2) != 0) {
2139 // Only make string's length dividable by 2
2143 // Return the hexadecimal string
2144 return $sign . $hex;
2148 * Converts a ASCII string (0 to 255) into a decimal number.
2150 * @param $asc The ASCII string to be converted
2151 * @return $dec Decimal number
2153 protected function asc2dec ($asc) {
2154 // Convert it into a hexadecimal number
2155 $hex = bin2hex($asc);
2157 // And back into a decimal number
2158 $dec = $this->hex2dec($hex);
2165 * Converts a decimal number into an ASCII string.
2167 * @param $dec Decimal number
2168 * @return $asc An ASCII string
2170 protected function dec2asc ($dec) {
2171 // First convert the number into a hexadecimal string
2172 $hex = $this->dec2hex($dec);
2174 // Then convert it into the ASCII string
2175 $asc = $this->hex2asc($hex);
2182 * Converts a hexadecimal number into an ASCII string. Negative numbers
2185 * @param $hex Hexadecimal string
2186 * @return $asc An ASCII string
2188 protected function hex2asc ($hex) {
2189 // Check for length, it must be devideable by 2
2190 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('hex='.$hex);
2191 assert((strlen($hex) % 2) == 0);
2195 for ($idx = 0; $idx < strlen($hex); $idx+=2) {
2196 // Get the decimal number of the chunk
2197 $part = hexdec(substr($hex, $idx, 2));
2199 // Add it to the final string
2203 // Return the final string
2208 * Checks whether the given encoded data was encoded with Base64
2210 * @param $encodedData Encoded data we shall check
2211 * @return $isBase64 Whether the encoded data is Base64
2213 protected function isBase64Encoded ($encodedData) {
2215 $isBase64 = (@base64_decode($encodedData, TRUE) !== FALSE);
2222 * "Getter" to get response/request type from analysis of the system.
2224 * @return $responseType Analyzed response type
2226 protected function getResponseTypeFromSystem () {
2227 // Default is console
2228 $responseType = 'console';
2230 // Is 'HTTP_HOST' set?
2231 if (isset($_SERVER['HTTP_HOST'])) {
2232 // Then it is a HTTP response/request
2233 $responseType = 'http';
2237 return $responseType;
2241 * Gets a cache key from Criteria instance
2243 * @param $criteriaInstance An instance of a Criteria class
2244 * @param $onlyKeys Only use these keys for a cache key
2245 * @return $cacheKey A cache key suitable for lookup/storage purposes
2247 protected function getCacheKeyByCriteria (Criteria $criteriaInstance, array $onlyKeys = array()) {
2249 $cacheKey = sprintf('%s@%s',
2250 $this->__toString(),
2251 $criteriaInstance->getCacheKey($onlyKeys)
2255 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . ': cacheKey=' . $cacheKey);
2260 * Getter for startup time in miliseconds
2262 * @return $startupTime Startup time in miliseconds
2264 protected function getStartupTime () {
2265 return self::$startupTime;
2269 * "Getter" for a printable currently execution time in nice braces
2271 * @return $executionTime Current execution time in nice braces
2273 protected function getPrintableExecutionTime () {
2274 // Caculate the execution time
2275 $executionTime = microtime(TRUE) - $this->getStartupTime();
2277 // Pack it in nice braces
2278 $executionTime = sprintf('[ %01.5f ] ', $executionTime);
2281 return $executionTime;
2285 * Hashes a given string with a simple but stronger hash function (no salt)
2286 * and hex-encode it.
2288 * @param $str The string to be hashed
2289 * @return $hash The hash from string $str
2291 public static final function hash ($str) {
2292 // Hash given string with (better secure) hasher
2293 $hash = bin2hex(mhash(MHASH_SHA256, $str));
2300 * "Getter" for length of hash() output. This will be "cached" to speed up
2303 * @return $length Length of hash() output
2305 public static final function getHashLength () {
2307 if (is_null(self::$hashLength)) {
2308 // No, then hash a string and save its length.
2309 self::$hashLength = strlen(self::hash('abc123'));
2313 return self::$hashLength;
2317 * Checks whether the given number is really a number (only chars 0-9).
2319 * @param $num A string consisting only chars between 0 and 9
2320 * @param $castValue Whether to cast the value to double. Do only use this to secure numbers from Requestable classes.
2321 * @param $assertMismatch Whether to assert mismatches
2322 * @return $ret The (hopefully) secured numbered value
2324 public function bigintval ($num, $castValue = TRUE, $assertMismatch = FALSE) {
2325 // Filter all numbers out
2326 $ret = preg_replace('/[^0123456789]/', '', $num);
2329 if ($castValue === TRUE) {
2330 // Cast to biggest numeric type
2331 $ret = (double) $ret;
2334 // Assert only if requested
2335 if ($assertMismatch === TRUE) {
2336 // Has the whole value changed?
2337 assert(('' . $ret . '' != '' . $num . '') && (!is_null($num)));
2345 * Checks whether the given hexadecimal number is really a hex-number (only chars 0-9,a-f).
2347 * @param $num A string consisting only chars between 0 and 9
2348 * @param $assertMismatch Whether to assert mismatches
2349 * @return $ret The (hopefully) secured hext-numbered value
2351 public function hexval ($num, $assertMismatch = FALSE) {
2352 // Filter all numbers out
2353 $ret = preg_replace('/[^0123456789abcdefABCDEF]/', '', $num);
2355 // Assert only if requested
2356 if ($assertMismatch === TRUE) {
2357 // Has the whole value changed?
2358 assert(('' . $ret . '' != '' . $num . '') && (!is_null($num)));
2366 * Checks whether start/end marker are set
2368 * @param $data Data to be checked
2369 * @return $isset Whether start/end marker are set
2371 public final function ifStartEndMarkersSet ($data) {
2373 $isset = ((substr($data, 0, strlen(BaseRawDataHandler::STREAM_START_MARKER)) == BaseRawDataHandler::STREAM_START_MARKER) && (substr($data, -1 * strlen(BaseRawDataHandler::STREAM_END_MARKER), strlen(BaseRawDataHandler::STREAM_END_MARKER)) == BaseRawDataHandler::STREAM_END_MARKER));
2375 // ... and return it
2380 * Determines if an element is set in the generic array
2382 * @param $keyGroup Main group for the key
2383 * @param $subGroup Sub group for the key
2384 * @param $key Key to check
2385 * @param $element Element to check
2386 * @return $isset Whether the given key is set
2388 protected final function isGenericArrayElementSet ($keyGroup, $subGroup, $key, $element) {
2390 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element);
2393 $isset = isset($this->genericArray[$keyGroup][$subGroup][$key][$element]);
2399 * Determines if a key is set in the generic array
2401 * @param $keyGroup Main group for the key
2402 * @param $subGroup Sub group for the key
2403 * @param $key Key to check
2404 * @return $isset Whether the given key is set
2406 protected final function isGenericArrayKeySet ($keyGroup, $subGroup, $key) {
2408 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2411 $isset = isset($this->genericArray[$keyGroup][$subGroup][$key]);
2419 * Determines if a group is set in the generic array
2421 * @param $keyGroup Main group
2422 * @param $subGroup Sub group
2423 * @return $isset Whether the given group is set
2425 protected final function isGenericArrayGroupSet ($keyGroup, $subGroup) {
2427 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup);
2430 $isset = isset($this->genericArray[$keyGroup][$subGroup]);
2437 * Getter for sub key group
2439 * @param $keyGroup Main key group
2440 * @param $subGroup Sub key group
2441 * @return $array An array with all array elements
2443 protected final function getGenericSubArray ($keyGroup, $subGroup) {
2445 if (!$this->isGenericArrayGroupSet($keyGroup, $subGroup)) {
2446 // No, then abort here
2447 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.');
2452 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',value=' . print_r($this->genericArray[$keyGroup][$subGroup], TRUE));
2455 return $this->genericArray[$keyGroup][$subGroup];
2459 * Unsets a given key in generic array
2461 * @param $keyGroup Main group for the key
2462 * @param $subGroup Sub group for the key
2463 * @param $key Key to unset
2466 protected final function unsetGenericArrayKey ($keyGroup, $subGroup, $key) {
2468 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2471 unset($this->genericArray[$keyGroup][$subGroup][$key]);
2475 * Unsets a given element in generic array
2477 * @param $keyGroup Main group for the key
2478 * @param $subGroup Sub group for the key
2479 * @param $key Key to unset
2480 * @param $element Element to unset
2483 protected final function unsetGenericArrayElement ($keyGroup, $subGroup, $key, $element) {
2485 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element);
2488 unset($this->genericArray[$keyGroup][$subGroup][$key][$element]);
2492 * Append a string to a given generic array key
2494 * @param $keyGroup Main group for the key
2495 * @param $subGroup Sub group for the key
2496 * @param $key Key to unset
2497 * @param $value Value to add/append
2500 protected final function appendStringToGenericArrayKey ($keyGroup, $subGroup, $key, $value, $appendGlue = '') {
2502 //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',value[' . gettype($value) . ']=' . print_r($value, TRUE) . ',appendGlue=' . $appendGlue);
2504 // Is it already there?
2505 if ($this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2507 $this->genericArray[$keyGroup][$subGroup][$key] .= $appendGlue . (string) $value;
2510 $this->genericArray[$keyGroup][$subGroup][$key] = (string) $value;
2515 * Append a string to a given generic array element
2517 * @param $keyGroup Main group for the key
2518 * @param $subGroup Sub group for the key
2519 * @param $key Key to unset
2520 * @param $element Element to check
2521 * @param $value Value to add/append
2524 protected final function appendStringToGenericArrayElement ($keyGroup, $subGroup, $key, $element, $value, $appendGlue = '') {
2526 //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',value[' . gettype($value) . ']=' . print_r($value, TRUE) . ',appendGlue=' . $appendGlue);
2528 // Is it already there?
2529 if ($this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element)) {
2531 $this->genericArray[$keyGroup][$subGroup][$key][$element] .= $appendGlue . (string) $value;
2534 $this->genericArray[$keyGroup][$subGroup][$key][$element] = (string) $value;
2539 * Initializes given generic array group
2541 * @param $keyGroup Main group for the key
2542 * @param $subGroup Sub group for the key
2543 * @param $key Key to use
2544 * @param $forceInit Optionally force initialization
2547 protected final function initGenericArrayGroup ($keyGroup, $subGroup, $forceInit = FALSE) {
2549 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',forceInit=' . intval($forceInit));
2551 // Is it already set?
2552 if (($forceInit === FALSE) && ($this->isGenericArrayGroupSet($keyGroup, $subGroup))) {
2553 // Already initialized
2554 trigger_error(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' already initialized.');
2559 $this->genericArray[$keyGroup][$subGroup] = array();
2563 * Initializes given generic array key
2565 * @param $keyGroup Main group for the key
2566 * @param $subGroup Sub group for the key
2567 * @param $key Key to use
2568 * @param $forceInit Optionally force initialization
2571 protected final function initGenericArrayKey ($keyGroup, $subGroup, $key, $forceInit = FALSE) {
2573 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',forceInit=' . intval($forceInit));
2575 // Is it already set?
2576 if (($forceInit === FALSE) && ($this->isGenericArrayKeySet($keyGroup, $subGroup, $key))) {
2577 // Already initialized
2578 trigger_error(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' already initialized.');
2583 $this->genericArray[$keyGroup][$subGroup][$key] = array();
2587 * Initializes given generic array element
2589 * @param $keyGroup Main group for the key
2590 * @param $subGroup Sub group for the key
2591 * @param $key Key to use
2592 * @param $element Element to use
2593 * @param $forceInit Optionally force initialization
2596 protected final function initGenericArrayElement ($keyGroup, $subGroup, $key, $element, $forceInit = FALSE) {
2598 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',forceInit=' . intval($forceInit));
2600 // Is it already set?
2601 if (($forceInit === FALSE) && ($this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element))) {
2602 // Already initialized
2603 trigger_error(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ' already initialized.');
2608 $this->genericArray[$keyGroup][$subGroup][$key][$element] = array();
2612 * Pushes an element to a generic key
2614 * @param $keyGroup Main group for the key
2615 * @param $subGroup Sub group for the key
2616 * @param $key Key to use
2617 * @param $value Value to add/append
2618 * @return $count Number of array elements
2620 protected final function pushValueToGenericArrayKey ($keyGroup, $subGroup, $key, $value) {
2622 //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',value[' . gettype($value) . ']=' . print_r($value, TRUE));
2625 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2627 $this->initGenericArrayKey($keyGroup, $subGroup, $key);
2631 $count = array_push($this->genericArray[$keyGroup][$subGroup][$key], $value);
2634 //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE));
2635 //* DEBUG: */ print(__METHOD__ . ': count=' . $count . PHP_EOL);
2640 * Pushes an element to a generic array element
2642 * @param $keyGroup Main group for the key
2643 * @param $subGroup Sub group for the key
2644 * @param $key Key to use
2645 * @param $element Element to check
2646 * @param $value Value to add/append
2647 * @return $count Number of array elements
2649 protected final function pushValueToGenericArrayElement ($keyGroup, $subGroup, $key, $element, $value) {
2651 //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',value[' . gettype($value) . ']=' . print_r($value, TRUE));
2654 if (!$this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element)) {
2656 $this->initGenericArrayElement($keyGroup, $subGroup, $key, $element);
2660 $count = array_push($this->genericArray[$keyGroup][$subGroup][$key][$element], $value);
2663 //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE));
2664 //* DEBUG: */ print(__METHOD__ . ': count=' . $count . PHP_EOL);
2669 * Pops an element from a generic group
2671 * @param $keyGroup Main group for the key
2672 * @param $subGroup Sub group for the key
2673 * @param $key Key to unset
2674 * @return $value Last "popped" value
2676 protected final function popGenericArrayElement ($keyGroup, $subGroup, $key) {
2678 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2681 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2683 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' not found.');
2688 $value = array_pop($this->genericArray[$keyGroup][$subGroup][$key]);
2691 //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE));
2692 //* DEBUG: */ print(__METHOD__ . ': value[' . gettype($value) . ']=' . print_r($value, TRUE) . PHP_EOL);
2697 * Shifts an element from a generic group
2699 * @param $keyGroup Main group for the key
2700 * @param $subGroup Sub group for the key
2701 * @param $key Key to unset
2702 * @return $value Last "popped" value
2704 protected final function shiftGenericArrayElement ($keyGroup, $subGroup, $key) {
2706 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2709 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2711 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' not found.');
2716 $value = array_shift($this->genericArray[$keyGroup][$subGroup][$key]);
2719 //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE));
2720 //* DEBUG: */ print(__METHOD__ . ': value[' . gettype($value) . ']=' . print_r($value, TRUE) . PHP_EOL);
2725 * Count generic array group
2727 * @param $keyGroup Main group for the key
2728 * @return $count Count of given group
2730 protected final function countGenericArray ($keyGroup) {
2732 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup);
2735 if (!isset($this->genericArray[$keyGroup])) {
2737 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ' not found.');
2742 $count = count($this->genericArray[$keyGroup]);
2745 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',count=' . $count);
2752 * Count generic array sub group
2754 * @param $keyGroup Main group for the key
2755 * @param $subGroup Sub group for the key
2756 * @return $count Count of given group
2758 protected final function countGenericArrayGroup ($keyGroup, $subGroup) {
2760 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup);
2763 if (!$this->isGenericArrayGroupSet($keyGroup, $subGroup)) {
2765 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.');
2770 $count = count($this->genericArray[$keyGroup][$subGroup]);
2773 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',count=' . $count);
2780 * Count generic array elements
2782 * @param $keyGroup Main group for the key
2783 * @param $subGroup Sub group for the key
2784 * @para $key Key to count
2785 * @return $count Count of given key
2787 protected final function countGenericArrayElements ($keyGroup, $subGroup, $key) {
2789 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2792 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2794 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.');
2796 } elseif (!$this->isValidGenericArrayGroup($keyGroup, $subGroup)) {
2798 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' is not an array.');
2803 $count = count($this->genericArray[$keyGroup][$subGroup][$key]);
2806 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',count=' . $count);
2813 * Getter for whole generic group array
2815 * @param $keyGroup Key group to get
2816 * @return $array Whole generic array group
2818 protected final function getGenericArray ($keyGroup) {
2820 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup);
2823 if (!isset($this->genericArray[$keyGroup])) {
2825 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ' does not exist.');
2830 return $this->genericArray[$keyGroup];
2834 * Setter for generic array key
2836 * @param $keyGroup Key group to get
2837 * @param $subGroup Sub group for the key
2838 * @param $key Key to unset
2839 * @param $value Mixed value from generic array element
2842 protected final function setGenericArrayKey ($keyGroup, $subGroup, $key, $value) {
2844 //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',value[' . gettype($value) . ']=' . print_r($value, TRUE));
2847 $this->genericArray[$keyGroup][$subGroup][$key] = $value;
2851 * Getter for generic array key
2853 * @param $keyGroup Key group to get
2854 * @param $subGroup Sub group for the key
2855 * @param $key Key to unset
2856 * @return $value Mixed value from generic array element
2858 protected final function getGenericArrayKey ($keyGroup, $subGroup, $key) {
2860 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2863 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2865 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' does not exist.');
2870 return $this->genericArray[$keyGroup][$subGroup][$key];
2874 * Sets a value in given generic array key/element
2876 * @param $keyGroup Main group for the key
2877 * @param $subGroup Sub group for the key
2878 * @param $key Key to set
2879 * @param $element Element to set
2880 * @param $value Value to set
2883 protected final function setGenericArrayElement ($keyGroup, $subGroup, $key, $element, $value) {
2885 //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',value[' . gettype($value) . ']=' . print_r($value, TRUE));
2888 $this->genericArray[$keyGroup][$subGroup][$key][$element] = $value;
2892 * Getter for generic array element
2894 * @param $keyGroup Key group to get
2895 * @param $subGroup Sub group for the key
2896 * @param $key Key to look for
2897 * @param $element Element to look for
2898 * @return $value Mixed value from generic array element
2900 protected final function getGenericArrayElement ($keyGroup, $subGroup, $key, $element) {
2902 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element);
2905 if (!$this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element)) {
2907 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ' does not exist.');
2912 return $this->genericArray[$keyGroup][$subGroup][$key][$element];
2916 * Checks if a given sub group is valid (array)
2918 * @param $keyGroup Key group to get
2919 * @param $subGroup Sub group for the key
2920 * @return $isValid Whether given sub group is valid
2922 protected final function isValidGenericArrayGroup ($keyGroup, $subGroup) {
2924 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup);
2927 $isValid = (($this->isGenericArrayGroupSet($keyGroup, $subGroup)) && (is_array($this->getGenericSubArray($keyGroup, $subGroup))));
2934 * Checks if a given key is valid (array)
2936 * @param $keyGroup Key group to get
2937 * @param $subGroup Sub group for the key
2938 * @param $key Key to check
2939 * @return $isValid Whether given sub group is valid
2941 protected final function isValidGenericArrayKey ($keyGroup, $subGroup, $key) {
2943 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2946 $isValid = (($this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) && (is_array($this->getGenericArrayKey($keyGroup, $subGroup, $key))));
2953 * Translates boolean TRUE to 'Y' and FALSE to 'N'
2955 * @param $boolean Boolean value
2956 * @return $translated Translated boolean value
2958 public static final function translateBooleanToYesNo ($boolean) {
2959 // Make sure it is really boolean
2960 assert(is_bool($boolean));
2963 $translated = ($boolean === TRUE) ? 'Y' : 'N';
2965 // ... and return it