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@ship-simu.org>
8 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
9 * @license GNU GPL 3.0 or any newer version
10 * @link http://www.ship-simu.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 {
29 private $realClass = 'BaseFrameworkSystem';
32 * Instance of a request class
34 private $requestInstance = NULL;
37 * Instance of a response class
39 private $responseInstance = NULL;
42 * Search criteria instance
44 private $searchInstance = NULL;
47 * Update criteria instance
49 private $updateInstance = NULL;
52 * The file I/O instance for the template loader
54 private $fileIoInstance = NULL;
59 private $resolverInstance = NULL;
62 * Template engine instance
64 private $templateInstance = NULL;
67 * Database result instance
69 private $resultInstance = NULL;
72 * Instance for user class
74 private $userInstance = NULL;
77 * A controller instance
79 private $controllerInstance = NULL;
84 private $rngInstance = NULL;
87 * Instance of a crypto helper
89 private $cryptoInstance = NULL;
92 * Instance of an Iterator class
94 private $iteratorInstance = NULL;
97 * Instance of the list
99 private $listInstance = NULL;
104 private $menuInstance = NULL;
107 * Instance of the image
109 private $imageInstance = NULL;
112 * Instance of the stacker
114 private $stackerInstance = NULL;
117 * A Compressor instance
119 private $compressorInstance = NULL;
122 * A Parseable instance
124 private $parserInstance = NULL;
127 * A ProtocolHandler instance
129 private $protocolInstance = NULL;
132 * A database wrapper instance
134 private $databaseInstance = NULL;
137 * A helper instance for the form
139 private $helperInstance = NULL;
142 * An instance of a Sourceable class
144 private $sourceInstance = NULL;
147 * An instance of a InputStreamable class
149 private $inputStreamInstance = NULL;
152 * An instance of a OutputStreamable class
154 private $outputStreamInstance = NULL;
157 * Networkable handler instance
159 private $handlerInstance = NULL;
162 * Visitor handler instance
164 private $visitorInstance = NULL;
169 private $dhtInstance = NULL;
172 * An instance of a database wrapper class
174 private $wrapperInstance = NULL;
177 * Thousands separator
179 private $thousands = '.'; // German
184 private $decimals = ','; // German
189 private $socketResource = FALSE;
194 private $packageData = array();
199 private $genericArray = array();
201 /***********************
202 * Exception codes.... *
203 ***********************/
205 // @todo Try to clean these constants up
206 const EXCEPTION_IS_NULL_POINTER = 0x001;
207 const EXCEPTION_IS_NO_OBJECT = 0x002;
208 const EXCEPTION_IS_NO_ARRAY = 0x003;
209 const EXCEPTION_MISSING_METHOD = 0x004;
210 const EXCEPTION_CLASSES_NOT_MATCHING = 0x005;
211 const EXCEPTION_INDEX_OUT_OF_BOUNDS = 0x006;
212 const EXCEPTION_DIMENSION_ARRAY_INVALID = 0x007;
213 const EXCEPTION_ITEM_NOT_TRADEABLE = 0x008;
214 const EXCEPTION_ITEM_NOT_IN_PRICE_LIST = 0x009;
215 const EXCEPTION_GENDER_IS_WRONG = 0x00a;
216 const EXCEPTION_BIRTH_DATE_IS_INVALID = 0x00b;
217 const EXCEPTION_EMPTY_STRUCTURES_ARRAY = 0x00c;
218 const EXCEPTION_HAS_ALREADY_PERSONELL_LIST = 0x00d;
219 const EXCEPTION_NOT_ENOUGTH_UNEMPLOYEES = 0x00e;
220 const EXCEPTION_TOTAL_PRICE_NOT_CALCULATED = 0x00f;
221 const EXCEPTION_HARBOR_HAS_NO_SHIPYARDS = 0x010;
222 const EXCEPTION_CONTRACT_PARTNER_INVALID = 0x011;
223 const EXCEPTION_CONTRACT_PARTNER_MISMATCH = 0x012;
224 const EXCEPTION_CONTRACT_ALREADY_SIGNED = 0x013;
225 const EXCEPTION_UNEXPECTED_EMPTY_STRING = 0x014;
226 const EXCEPTION_PATH_NOT_FOUND = 0x015;
227 const EXCEPTION_INVALID_PATH_NAME = 0x016;
228 const EXCEPTION_READ_PROTECED_PATH = 0x017;
229 const EXCEPTION_WRITE_PROTECED_PATH = 0x018;
230 const EXCEPTION_DIR_POINTER_INVALID = 0x019;
231 const EXCEPTION_FILE_POINTER_INVALID = 0x01a;
232 const EXCEPTION_INVALID_RESOURCE = 0x01b;
233 const EXCEPTION_UNEXPECTED_OBJECT = 0x01c;
234 const EXCEPTION_LIMIT_ELEMENT_IS_UNSUPPORTED = 0x01d;
235 const EXCEPTION_GETTER_IS_MISSING = 0x01e;
236 const EXCEPTION_ARRAY_EXPECTED = 0x01f;
237 const EXCEPTION_ARRAY_HAS_INVALID_COUNT = 0x020;
238 const EXCEPTION_ID_IS_INVALID_FORMAT = 0x021;
239 const EXCEPTION_MD5_CHECKSUMS_MISMATCH = 0x022;
240 const EXCEPTION_UNEXPECTED_STRING_SIZE = 0x023;
241 const EXCEPTION_SIMULATOR_ID_INVALID = 0x024;
242 const EXCEPTION_MISMATCHING_COMPRESSORS = 0x025;
243 const EXCEPTION_CONTAINER_ITEM_IS_NULL = 0x026;
244 const EXCEPTION_ITEM_IS_NO_ARRAY = 0x027;
245 const EXCEPTION_CONTAINER_MAYBE_DAMAGED = 0x028;
246 const EXCEPTION_INVALID_STRING = 0x029;
247 const EXCEPTION_VARIABLE_NOT_SET = 0x02a;
248 const EXCEPTION_ATTRIBUTES_ARE_MISSING = 0x02b;
249 const EXCEPTION_ARRAY_ELEMENTS_MISSING = 0x02c;
250 const EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED = 0x02d;
251 const EXCEPTION_UNSPPORTED_OPERATION = 0x02e;
252 const EXCEPTION_MISSING_ELEMENT = 0x030;
253 const EXCEPTION_HEADERS_ALREADY_SENT = 0x031;
254 const EXCEPTION_DEFAULT_CONTROLLER_GONE = 0x032;
255 const EXCEPTION_CLASS_NOT_FOUND = 0x033;
256 const EXCEPTION_REQUIRED_INTERFACE_MISSING = 0x034;
257 const EXCEPTION_FATAL_ERROR = 0x035;
258 const EXCEPTION_FILE_NOT_FOUND = 0x036;
259 const EXCEPTION_ASSERTION_FAILED = 0x037;
260 const EXCEPTION_FILE_CANNOT_BE_READ = 0x038;
261 const EXCEPTION_DATABASE_UPDATED_NOT_ALLOWED = 0x039;
262 const EXCEPTION_FILTER_CHAIN_INTERCEPTED = 0x040;
265 * Hexadecimal->Decimal translation array
267 private static $hexdec = array(
287 * Decimal->hexadecimal translation array
289 private static $dechex = array(
309 * Startup time in miliseconds
311 private static $startupTime = 0;
314 * Protected super constructor
316 * @param $className Name of the class
319 protected function __construct ($className) {
321 $this->setRealClass($className);
323 // Set configuration instance if no registry ...
324 if (!$this instanceof Register) {
325 // ... because registries doesn't need to be configured
326 $this->setConfigInstance(FrameworkConfiguration::getSelfInstance());
329 // Is the startup time set? (0 cannot be true anymore)
330 if (self::$startupTime == 0) {
332 self::$startupTime = microtime(true);
337 * Destructor for all classes
341 public function __destruct () {
342 // Flush any updated entries to the database
343 $this->flushPendingUpdates();
345 // Is this object already destroyed?
346 if ($this->__toString() != 'DestructedObject') {
347 // Destroy all informations about this class but keep some text about it alive
348 $this->setRealClass('DestructedObject');
349 } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
350 // Already destructed object
351 self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:] The object <span class="object_name">%s</span> is already destroyed.',
356 // Do not call this twice
357 trigger_error(__METHOD__ . ': Called twice.');
362 * The __call() method where all non-implemented methods end up
364 * @param $methodName Name of the missing method
365 * @args $args Arguments passed to the method
368 public final function __call ($methodName, $args) {
369 return self::__callStatic($methodName, $args);
373 * The __callStatic() method where all non-implemented static methods end up
375 * @param $methodName Name of the missing method
376 * @args $args Arguments passed to the method
379 public static final function __callStatic ($methodName, $args) {
380 // Init argument string
383 // Is it empty or an array?
386 $argsString = 'NULL';
387 } elseif (is_array($args)) {
388 // Some arguments are there
389 foreach ($args as $arg) {
390 // Add the value itself if not array. This prevents 'array to string conversion' message
391 if (is_array($arg)) {
392 $argsString .= 'Array';
397 // Add data about the argument
398 $argsString .= ' (' . gettype($arg);
400 if (is_string($arg)) {
401 // Add length for strings
402 $argsString .= ', ' . strlen($arg);
403 } elseif (is_array($arg)) {
404 // .. or size if array
405 $argsString .= ', ' . count($arg);
406 } elseif ($arg === TRUE) {
407 // ... is boolean 'true'
408 $argsString .= ', true';
409 } elseif ($arg === FALSE) {
410 // ... is boolean 'true'
411 $argsString .= ', false';
415 $argsString .= '), ';
419 if (substr($argsString, -2, 1) == ',') {
420 $argsString = substr($argsString, 0, -2);
423 // Invalid arguments!
424 $argsString = '!INVALID:' . gettype($args) . '!';
427 // Output stub message
428 // @TODO __CLASS__ does always return BaseFrameworkSystem but not the extending (=child) class
429 self::createDebugInstance(__CLASS__)->debugOutput(sprintf("[unknown::%s:] Stub! Args: %s",
439 * Getter for $realClass
441 * @return $realClass The name of the real class (not BaseFrameworkSystem)
443 public function __toString () {
444 return $this->realClass;
448 * Magic function to catch setting of missing but set class fields/attributes
450 * @param $name Name of the field/attribute
451 * @param $value Value to store
454 public final function __set ($name, $value) {
455 $this->debugBackTrace(sprintf("Tried to set a missing field. name=%s, value[%s]=%s",
463 * Magic function to catch getting of missing fields/attributes
465 * @param $name Name of the field/attribute
468 public final function __get ($name) {
469 $this->debugBackTrace(sprintf("Tried to get a missing field. name=%s",
475 * Magic function to catch unsetting of missing fields/attributes
477 * @param $name Name of the field/attribute
480 public final function __unset ($name) {
481 $this->debugBackTrace(sprintf("Tried to unset a missing field. name=%s",
487 * Setter for the real class name
489 * @param $realClass Class name (string)
492 public final function setRealClass ($realClass) {
494 $this->realClass = (string) $realClass;
498 * Setter for database result instance
500 * @param $resultInstance An instance of a database result class
502 * @todo SearchableResult and UpdateableResult shall have a super interface to use here
504 protected final function setResultInstance (SearchableResult $resultInstance) {
505 $this->resultInstance = $resultInstance;
509 * Getter for database result instance
511 * @return $resultInstance An instance of a database result class
513 public final function getResultInstance () {
514 return $this->resultInstance;
518 * Setter for template engine instances
520 * @param $templateInstance An instance of a template engine class
523 protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
524 $this->templateInstance = $templateInstance;
528 * Getter for template engine instances
530 * @return $templateInstance An instance of a template engine class
532 protected final function getTemplateInstance () {
533 return $this->templateInstance;
537 * Setter for search instance
539 * @param $searchInstance Searchable criteria instance
542 public final function setSearchInstance (LocalSearchCriteria $searchInstance) {
543 $this->searchInstance = $searchInstance;
547 * Getter for search instance
549 * @return $searchInstance Searchable criteria instance
551 public final function getSearchInstance () {
552 return $this->searchInstance;
556 * Setter for update instance
558 * @param $updateInstance Searchable criteria instance
561 public final function setUpdateInstance (LocalUpdateCriteria $updateInstance) {
562 $this->updateInstance = $updateInstance;
566 * Getter for update instance
568 * @return $updateInstance Updateable criteria instance
570 public final function getUpdateInstance () {
571 return $this->updateInstance;
575 * Setter for resolver instance
577 * @param $resolverInstance Instance of a command resolver class
580 public final function setResolverInstance (Resolver $resolverInstance) {
581 $this->resolverInstance = $resolverInstance;
585 * Getter for resolver instance
587 * @return $resolverInstance Instance of a command resolver class
589 public final function getResolverInstance () {
590 return $this->resolverInstance;
594 * Setter for language instance
596 * @param $configInstance The configuration instance which shall
597 * be FrameworkConfiguration
600 public final function setConfigInstance (FrameworkConfiguration $configInstance) {
601 Registry::getRegistry()->addInstance('config', $configInstance);
605 * Getter for configuration instance
607 * @return $configInstance Configuration instance
609 public final function getConfigInstance () {
610 $configInstance = Registry::getRegistry()->getInstance('config');
611 return $configInstance;
615 * Setter for debug instance
617 * @param $debugInstance The instance for debug output class
620 public final function setDebugInstance (DebugMiddleware $debugInstance) {
621 Registry::getRegistry()->addInstance('debug', $debugInstance);
625 * Getter for debug instance
627 * @return $debugInstance Instance to class DebugConsoleOutput or DebugWebOutput
629 public final function getDebugInstance () {
630 // Get debug instance
631 $debugInstance = Registry::getRegistry()->getInstance('debug');
634 return $debugInstance;
638 * Setter for web output instance
640 * @param $webInstance The instance for web output class
643 public final function setWebOutputInstance (OutputStreamer $webInstance) {
644 Registry::getRegistry()->addInstance('web_output', $webInstance);
648 * Getter for web output instance
650 * @return $webOutputInstance - Instance to class WebOutput
652 public final function getWebOutputInstance () {
653 $webOutputInstance = Registry::getRegistry()->getInstance('web_output');
654 return $webOutputInstance;
658 * Setter for database instance
660 * @param $databaseInstance The instance for the database connection (forced DatabaseConnection)
663 public final function setDatabaseInstance (DatabaseConnection $databaseInstance) {
664 Registry::getRegistry()->addInstance('db_instance', $databaseInstance);
668 * Getter for database layer
670 * @return $databaseInstance The database layer instance
672 public final function getDatabaseInstance () {
674 $databaseInstance = Registry::getRegistry()->getInstance('db_instance');
677 return $databaseInstance;
681 * Setter for compressor channel
683 * @param $compressorInstance An instance of CompressorChannel
686 public final function setCompressorChannel (CompressorChannel $compressorInstance) {
687 Registry::getRegistry()->addInstance('compressor', $compressorInstance);
691 * Getter for compressor channel
693 * @return $compressorInstance The compressor channel
695 public final function getCompressorChannel () {
696 $compressorInstance = Registry::getRegistry()->getInstance('compressor');
697 return $compressorInstance;
701 * Protected getter for a manageable application helper class
703 * @return $applicationInstance An instance of a manageable application helper class
705 protected final function getApplicationInstance () {
706 $applicationInstance = Registry::getRegistry()->getInstance('application');
707 return $applicationInstance;
711 * Setter for a manageable application helper class
713 * @param $applicationInstance An instance of a manageable application helper class
716 public final function setApplicationInstance (ManageableApplication $applicationInstance) {
717 Registry::getRegistry()->addInstance('application', $applicationInstance);
721 * Setter for request instance
723 * @param $requestInstance An instance of a Requestable class
726 public final function setRequestInstance (Requestable $requestInstance) {
727 $this->requestInstance = $requestInstance;
731 * Getter for request instance
733 * @return $requestInstance An instance of a Requestable class
735 public final function getRequestInstance () {
736 return $this->requestInstance;
740 * Setter for response instance
742 * @param $responseInstance An instance of a Responseable class
745 public final function setResponseInstance (Responseable $responseInstance) {
746 $this->responseInstance = $responseInstance;
750 * Getter for response instance
752 * @return $responseInstance An instance of a Responseable class
754 public final function getResponseInstance () {
755 return $this->responseInstance;
759 * Private getter for language instance
761 * @return $langInstance An instance to the language sub-system
763 protected final function getLanguageInstance () {
764 $langInstance = Registry::getRegistry()->getInstance('language');
765 return $langInstance;
769 * Setter for language instance
771 * @param $langInstance An instance to the language sub-system
773 * @see LanguageSystem
775 public final function setLanguageInstance (ManageableLanguage $langInstance) {
776 Registry::getRegistry()->addInstance('language', $langInstance);
780 * Private getter for file IO instance
782 * @return $fileIoInstance An instance to the file I/O sub-system
784 protected final function getFileIoInstance () {
785 return $this->fileIoInstance;
789 * Setter for file I/O instance
791 * @param $fileIoInstance An instance to the file I/O sub-system
794 public final function setFileIoInstance (IoHandler $fileIoInstance) {
795 $this->fileIoInstance = $fileIoInstance;
799 * Protected setter for user instance
801 * @param $userInstance An instance of a user class
804 protected final function setUserInstance (ManageableAccount $userInstance) {
805 $this->userInstance = $userInstance;
809 * Getter for user instance
811 * @return $userInstance An instance of a user class
813 public final function getUserInstance () {
814 return $this->userInstance;
818 * Setter for controller instance (this surely breaks a bit the MVC patterm)
820 * @param $controllerInstance An instance of the controller
823 public final function setControllerInstance (Controller $controllerInstance) {
824 $this->controllerInstance = $controllerInstance;
828 * Getter for controller instance (this surely breaks a bit the MVC patterm)
830 * @return $controllerInstance An instance of the controller
832 public final function getControllerInstance () {
833 return $this->controllerInstance;
837 * Setter for RNG instance
839 * @param $rngInstance An instance of a random number generator (RNG)
842 protected final function setRngInstance (RandomNumberGenerator $rngInstance) {
843 $this->rngInstance = $rngInstance;
847 * Getter for RNG instance
849 * @return $rngInstance An instance of a random number generator (RNG)
851 public final function getRngInstance () {
852 return $this->rngInstance;
856 * Setter for Cryptable instance
858 * @param $cryptoInstance An instance of a Cryptable class
861 protected final function setCryptoInstance (Cryptable $cryptoInstance) {
862 $this->cryptoInstance = $cryptoInstance;
866 * Getter for Cryptable instance
868 * @return $cryptoInstance An instance of a Cryptable class
870 public final function getCryptoInstance () {
871 return $this->cryptoInstance;
875 * Setter for the list instance
877 * @param $listInstance A list of Listable
880 protected final function setListInstance (Listable $listInstance) {
881 $this->listInstance = $listInstance;
885 * Getter for the list instance
887 * @return $listInstance A list of Listable
889 protected final function getListInstance () {
890 return $this->listInstance;
894 * Setter for the menu instance
896 * @param $menuInstance A RenderableMenu instance
899 protected final function setMenuInstance (RenderableMenu $menuInstance) {
900 $this->menuInstance = $menuInstance;
904 * Getter for the menu instance
906 * @return $menuInstance A RenderableMenu instance
908 protected final function getMenuInstance () {
909 return $this->menuInstance;
913 * Setter for image instance
915 * @param $imageInstance An instance of an image
918 public final function setImageInstance (BaseImage $imageInstance) {
919 $this->imageInstance = $imageInstance;
923 * Getter for image instance
925 * @return $imageInstance An instance of an image
927 public final function getImageInstance () {
928 return $this->imageInstance;
932 * Setter for stacker instance
934 * @param $stackerInstance An instance of an stacker
937 public final function setStackerInstance (Stackable $stackerInstance) {
938 $this->stackerInstance = $stackerInstance;
942 * Getter for stacker instance
944 * @return $stackerInstance An instance of an stacker
946 public final function getStackerInstance () {
947 return $this->stackerInstance;
951 * Setter for compressor instance
953 * @param $compressorInstance An instance of an compressor
956 public final function setCompressorInstance (Compressor $compressorInstance) {
957 $this->compressorInstance = $compressorInstance;
961 * Getter for compressor instance
963 * @return $compressorInstance An instance of an compressor
965 public final function getCompressorInstance () {
966 return $this->compressorInstance;
970 * Setter for Parseable instance
972 * @param $parserInstance An instance of an Parseable
975 public final function setParserInstance (Parseable $parserInstance) {
976 $this->parserInstance = $parserInstance;
980 * Getter for Parseable instance
982 * @return $parserInstance An instance of an Parseable
984 public final function getParserInstance () {
985 return $this->parserInstance;
989 * Setter for ProtocolHandler instance
991 * @param $protocolInstance An instance of an ProtocolHandler
994 public final function setProtocolInstance (ProtocolHandler $protocolInstance = NULL) {
995 $this->protocolInstance = $protocolInstance;
999 * Getter for ProtocolHandler instance
1001 * @return $protocolInstance An instance of an ProtocolHandler
1003 public final function getProtocolInstance () {
1004 return $this->protocolInstance;
1008 * Setter for DatabaseWrapper instance
1010 * @param $wrapperInstance An instance of an DatabaseWrapper
1013 public final function setWrapperInstance (DatabaseWrapper $wrapperInstance) {
1014 $this->wrapperInstance = $wrapperInstance;
1018 * Getter for DatabaseWrapper instance
1020 * @return $wrapperInstance An instance of an DatabaseWrapper
1022 public final function getWrapperInstance () {
1023 return $this->wrapperInstance;
1027 * Setter for socket resource
1029 * @param $socketResource A valid socket resource
1032 public final function setSocketResource ($socketResource) {
1033 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': socketResource=' . $socketResource . ',previous[' . gettype($this->socketResource) . ']=' . $this->socketResource);
1034 $this->socketResource = $socketResource;
1038 * Getter for socket resource
1040 * @return $socketResource A valid socket resource
1042 public final function getSocketResource () {
1043 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': socketResource[' . gettype($this->socketResource) . ']=' . $this->socketResource);
1044 return $this->socketResource;
1048 * Setter for helper instance
1050 * @param $helperInstance An instance of a helper class
1053 protected final function setHelperInstance (Helper $helperInstance) {
1054 $this->helperInstance = $helperInstance;
1058 * Getter for helper instance
1060 * @return $helperInstance An instance of a helper class
1062 public final function getHelperInstance () {
1063 return $this->helperInstance;
1067 * Setter for a Sourceable instance
1069 * @param $sourceInstance The Sourceable instance
1072 protected final function setSourceInstance (Sourceable $sourceInstance) {
1073 $this->sourceInstance = $sourceInstance;
1077 * Getter for a Sourceable instance
1079 * @return $sourceInstance The Sourceable instance
1081 protected final function getSourceInstance () {
1082 return $this->sourceInstance;
1086 * Getter for a InputStreamable instance
1088 * @param $inputStreamInstance The InputStreamable instance
1090 protected final function getInputStreamInstance () {
1091 return $this->inputStreamInstance;
1095 * Setter for a InputStreamable instance
1097 * @param $inputStreamInstance The InputStreamable instance
1100 protected final function setInputStreamInstance (InputStreamable $inputStreamInstance) {
1101 $this->inputStreamInstance = $inputStreamInstance;
1105 * Getter for a OutputStreamable instance
1107 * @param $outputStreamInstance The OutputStreamable instance
1109 protected final function getOutputStreamInstance () {
1110 return $this->outputStreamInstance;
1114 * Setter for a OutputStreamable instance
1116 * @param $outputStreamInstance The OutputStreamable instance
1119 protected final function setOutputStreamInstance (OutputStreamable $outputStreamInstance) {
1120 $this->outputStreamInstance = $outputStreamInstance;
1124 * Setter for handler instance
1126 * @param $handlerInstance An instance of a Handleable class
1129 protected final function setHandlerInstance (Handleable $handlerInstance) {
1130 $this->handlerInstance = $handlerInstance;
1134 * Getter for handler instance
1136 * @return $handlerInstance A Networkable instance
1138 protected final function getHandlerInstance () {
1139 return $this->handlerInstance;
1143 * Setter for visitor instance
1145 * @param $visitorInstance A Visitor instance
1148 protected final function setVisitorInstance (Visitor $visitorInstance) {
1149 $this->visitorInstance = $visitorInstance;
1153 * Getter for visitor instance
1155 * @return $visitorInstance A Visitor instance
1157 protected final function getVisitorInstance () {
1158 return $this->visitorInstance;
1162 * Setter for DHT instance
1164 * @param $dhtInstance A Distributable instance
1167 protected final function setDhtInstance (Distributable $dhtInstance) {
1168 $this->dhtInstance = $dhtInstance;
1172 * Getter for DHT instance
1174 * @return $dhtInstance A Distributable instance
1176 protected final function getDhtInstance () {
1177 return $this->dhtInstance;
1181 * Setter for raw package Data
1183 * @param $packageData Raw package Data
1186 public final function setPackageData (array $packageData) {
1187 $this->packageData = $packageData;
1191 * Getter for raw package Data
1193 * @return $packageData Raw package Data
1195 public function getPackageData () {
1196 return $this->packageData;
1201 * Setter for Iterator instance
1203 * @param $iteratorInstance An instance of an Iterator
1206 protected final function setIteratorInstance (Iterator $iteratorInstance) {
1207 $this->iteratorInstance = $iteratorInstance;
1211 * Getter for Iterator instance
1213 * @return $iteratorInstance An instance of an Iterator
1215 public final function getIteratorInstance () {
1216 return $this->iteratorInstance;
1220 * Checks whether an object equals this object. You should overwrite this
1221 * method to implement own equality checks
1223 * @param $objectInstance An instance of a FrameworkInterface object
1224 * @return $equals Whether both objects equals
1226 public function equals (FrameworkInterface $objectInstance) {
1229 $this->__toString() == $objectInstance->__toString()
1231 $this->hashCode() == $objectInstance->hashCode()
1234 // Return the result
1239 * Generates a generic hash code of this class. You should really overwrite
1240 * this method with your own hash code generator code. But keep KISS in mind.
1242 * @return $hashCode A generic hash code respresenting this whole class
1244 public function hashCode () {
1246 return crc32($this->__toString());
1250 * Formats computer generated price values into human-understandable formats
1251 * with thousand and decimal separators.
1253 * @param $value The in computer format value for a price
1254 * @param $currency The currency symbol (use HTML-valid characters!)
1255 * @param $decNum Number of decimals after commata
1256 * @return $price The for the current language formated price string
1257 * @throws MissingDecimalsThousandsSeparatorException If decimals or
1258 * thousands separator
1261 public function formatCurrency ($value, $currency = '€', $decNum = 2) {
1262 // Are all required attriutes set?
1263 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
1264 // Throw an exception
1265 throw new MissingDecimalsThousandsSeparatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
1269 $value = (float) $value;
1271 // Reformat the US number
1272 $price = number_format($value, $decNum, $this->decimals, $this->thousands) . $currency;
1274 // Return as string...
1279 * Appends a trailing slash to a string
1281 * @param $str A string (maybe) without trailing slash
1282 * @return $str A string with an auto-appended trailing slash
1284 public final function addMissingTrailingSlash ($str) {
1285 // Is there a trailing slash?
1286 if (substr($str, -1, 1) != '/') {
1290 // Return string with trailing slash
1295 * Prepare the template engine (WebTemplateEngine by default) for a given
1296 * application helper instance (ApplicationHelper by default).
1298 * @param $applicationInstance An application helper instance or
1299 * null if we shall use the default
1300 * @return $templateInstance The template engine instance
1301 * @throws NullPointerException If the discovered application
1302 * instance is still null
1304 protected function prepareTemplateInstance (ManageableApplication $applicationInstance = NULL) {
1305 // Is the application instance set?
1306 if (is_null($applicationInstance)) {
1307 // Get the current instance
1308 $applicationInstance = $this->getApplicationInstance();
1311 if (is_null($applicationInstance)) {
1312 // Thrown an exception
1313 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1317 // Initialize the template engine
1318 $templateInstance = ObjectFactory::createObjectByConfiguredName('web_template_class');
1320 // Return the prepared instance
1321 return $templateInstance;
1325 * Debugs this instance by putting out it's full content
1327 * @param $message Optional message to show in debug output
1330 public final function debugInstance ($message = '') {
1331 // Restore the error handler to avoid trouble with missing array elements or undeclared variables
1332 restore_error_handler();
1337 // Is a message set?
1338 if (!empty($message)) {
1339 // Construct message
1340 $content = sprintf("<div class=\"debug_message\">Message: %s</div>\n", $message);
1343 // Generate the output
1344 $content .= sprintf("<pre>%s</pre>",
1347 print_r($this, true)
1353 ApplicationEntryPoint::app_exit(sprintf("<div class=\"debug_header\">%s debug output:</div><div class=\"debug_content\">%s</div>\nLoaded includes: <div class=\"debug_include_list\">%s</div>",
1354 $this->__toString(),
1356 ClassLoader::getSelfInstance()->getPrintableIncludeList()
1361 * Replaces control characters with printable output
1363 * @param $str String with control characters
1364 * @return $str Replaced string
1366 protected function replaceControlCharacters ($str) {
1369 chr(13), '[r]', str_replace(
1370 chr(10), '[n]', str_replace(
1380 * Output a partial stub message for the caller method
1382 * @param $message An optional message to display
1385 protected function partialStub ($message = '') {
1386 // Get the backtrace
1387 $backtrace = debug_backtrace();
1389 // Generate the class::method string
1390 $methodName = 'UnknownClass->unknownMethod';
1391 if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
1392 $methodName = $backtrace[1]['class'] . '->' . $backtrace[1]['function'];
1395 // Construct the full message
1396 $stubMessage = sprintf('[%s:] Partial stub!',
1400 // Is the extra message given?
1401 if (!empty($message)) {
1402 // Then add it as well
1403 $stubMessage .= ' Message: ' . $message;
1406 // Debug instance is there?
1407 if (!is_null($this->getDebugInstance())) {
1408 // Output stub message
1409 self::createDebugInstance(__CLASS__)->debugOutput($stubMessage);
1412 trigger_error($stubMessage);
1417 * Outputs a debug backtrace and stops further script execution
1419 * @param $message An optional message to output
1420 * @param $doExit Whether exit the program (true is default)
1423 public function debugBackTrace ($message = '', $doExit = TRUE) {
1424 // Sorry, there is no other way getting this nice backtrace
1425 if (!empty($message)) {
1427 printf('Message: %s<br />' . chr(10), $message);
1431 debug_print_backtrace();
1435 if ($doExit === TRUE) {
1441 * Creates an instance of a debugger instance
1443 * @param $className Name of the class (currently unsupported)
1444 * @return $debugInstance An instance of a debugger class
1446 public final static function createDebugInstance ($className) {
1447 // Init debug instance
1448 $debugInstance = NULL;
1452 // Get a debugger instance
1453 $debugInstance = DebugMiddleware::createDebugMiddleware(FrameworkConfiguration::getSelfInstance()->getConfigEntry('debug_class'));
1454 } catch (NullPointerException $e) {
1455 // Didn't work, no instance there
1456 exit('Cannot create debugInstance! Exception=' . $e->__toString() . ', message=' . $e->getMessage());
1459 // Empty string should be ignored and used for testing the middleware
1460 DebugMiddleware::getSelfInstance()->output('');
1463 return $debugInstance;
1467 * Outputs a debug message whether to debug instance (should be set!) or
1468 * dies with or ptints the message. Do NEVER EVER rewrite the exit() call to
1469 * ApplicationEntryPoint::app_exit(), this would cause an endless loop.
1471 * @param $message Message we shall send out...
1472 * @param $doPrint Whether print or die here (default: print)
1473 * @paran $stripTags Whether to strip tags (default: false)
1476 public function debugOutput ($message, $doPrint = TRUE, $stripTags = FALSE) {
1477 // Set debug instance to NULL
1478 $debugInstance = NULL;
1482 // Get debug instance
1483 $debugInstance = $this->getDebugInstance();
1484 } catch (NullPointerException $e) {
1485 // The debug instance is not set (yet)
1488 // Is the debug instance there?
1489 if (is_object($debugInstance)) {
1490 // Use debug output handler
1491 $debugInstance->output($message, $stripTags);
1493 if ($doPrint === FALSE) {
1494 // Die here if not printed
1498 // Are debug times enabled?
1499 if ($this->getConfigInstance()->getConfigEntry('debug_output_timings') == 'Y') {
1501 $message = $this->getPrintableExecutionTime() . $message;
1505 if ($doPrint === TRUE) {
1507 print($message . chr(10));
1516 * Converts e.g. a command from URL to a valid class by keeping out bad characters
1518 * @param $str The string, what ever it is needs to be converted
1519 * @return $className Generated class name
1521 public function convertToClassName ($str) {
1525 // Convert all dashes in underscores
1526 $str = $this->convertDashesToUnderscores($str);
1528 // Now use that underscores to get classname parts for hungarian style
1529 foreach (explode('_', $str) as $strPart) {
1530 // Make the class name part lower case and first upper case
1531 $className .= ucfirst(strtolower($strPart));
1534 // Return class name
1539 * Converts dashes to underscores, e.g. useable for configuration entries
1541 * @param $str The string with maybe dashes inside
1542 * @return $str The converted string with no dashed, but underscores
1544 public final function convertDashesToUnderscores ($str) {
1546 $str = str_replace('-', '_', $str);
1548 // Return converted string
1553 * Marks up the code by adding e.g. line numbers
1555 * @param $phpCode Unmarked PHP code
1556 * @return $markedCode Marked PHP code
1558 public function markupCode ($phpCode) {
1563 $errorArray = error_get_last();
1565 // Init the code with error message
1566 if (is_array($errorArray)) {
1568 $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>',
1569 basename($errorArray['file']),
1570 $errorArray['line'],
1571 $errorArray['message'],
1576 // Add line number to the code
1577 foreach (explode(chr(10), $phpCode) as $lineNo => $code) {
1579 $markedCode .= sprintf('<span id="code_line">%s</span>: %s' . chr(10),
1581 htmlentities($code, ENT_QUOTES)
1590 * Filter a given GMT timestamp (non Uni* stamp!) to make it look more
1591 * beatiful for web-based front-ends. If null is given a message id
1592 * null_timestamp will be resolved and returned.
1594 * @param $timestamp Timestamp to prepare (filter) for display
1595 * @return $readable A readable timestamp
1597 public function doFilterFormatTimestamp ($timestamp) {
1598 // Default value to return
1601 // Is the timestamp null?
1602 if (is_null($timestamp)) {
1603 // Get a message string
1604 $readable = $this->getLanguageInstance()->getMessage('null_timestamp');
1606 switch ($this->getLanguageInstance()->getLanguageCode()) {
1607 case 'de': // German format is a bit different to default
1608 // Split the GMT stamp up
1609 $dateTime = explode(' ', $timestamp );
1610 $dateArray = explode('-', $dateTime[0]);
1611 $timeArray = explode(':', $dateTime[1]);
1613 // Construct the timestamp
1614 $readable = sprintf($this->getConfigInstance()->getConfigEntry('german_date_time'),
1624 default: // Default is pass-through
1625 $readable = $timestamp;
1635 * Filter a given number into a localized number
1637 * @param $value The raw value from e.g. database
1638 * @return $localized Localized value
1640 public function doFilterFormatNumber ($value) {
1641 // Generate it from config and localize dependencies
1642 switch ($this->getLanguageInstance()->getLanguageCode()) {
1643 case 'de': // German format is a bit different to default
1644 $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), ',', '.');
1647 default: // US, etc.
1648 $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), '.', ',');
1657 * "Getter" for databse entry
1659 * @return $entry An array with database entries
1660 * @throws NullPointerException If the database result is not found
1661 * @throws InvalidDatabaseResultException If the database result is invalid
1663 protected final function getDatabaseEntry () {
1664 // Is there an instance?
1665 if (is_null($this->getResultInstance())) {
1666 // Throw an exception here
1667 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1671 $this->getResultInstance()->rewind();
1673 // Do we have an entry?
1674 if ($this->getResultInstance()->valid() === FALSE) {
1675 throw new InvalidDatabaseResultException(array($this, $this->getResultInstance()), DatabaseResult::EXCEPTION_INVALID_DATABASE_RESULT);
1679 $this->getResultInstance()->next();
1682 $entry = $this->getResultInstance()->current();
1689 * Getter for field name
1691 * @param $fieldName Field name which we shall get
1692 * @return $fieldValue Field value from the user
1693 * @throws NullPointerException If the result instance is null
1695 public final function getField ($fieldName) {
1696 // Default field value
1699 // Get result instance
1700 $resultInstance = $this->getResultInstance();
1702 // Is this instance null?
1703 if (is_null($resultInstance)) {
1704 // Then the user instance is no longer valid (expired cookies?)
1705 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1708 // Get current array
1709 $fieldArray = $resultInstance->current();
1710 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($fieldName.':<pre>'.print_r($fieldArray, true).'</pre>');
1712 // Convert dashes to underscore
1713 $fieldName = $this->convertDashesToUnderscores($fieldName);
1715 // Does the field exist?
1716 if (isset($fieldArray[$fieldName])) {
1718 $fieldValue = $fieldArray[$fieldName];
1720 // Missing field entry, may require debugging
1721 self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . ':fieldname=' . $fieldName . ' not found!');
1729 * Flushs all pending updates to the database layer
1733 public function flushPendingUpdates () {
1734 // Get result instance
1735 $resultInstance = $this->getResultInstance();
1737 // Do we have data to update?
1738 if ((is_object($resultInstance)) && ($resultInstance->ifDataNeedsFlush())) {
1739 // Get wrapper class name config entry
1740 $configEntry = $resultInstance->getUpdateInstance()->getWrapperConfigEntry();
1742 // Create object instance
1743 $wrapperInstance = ObjectFactory::createObjectByConfiguredName($configEntry);
1745 // Yes, then send the whole result to the database layer
1746 $wrapperInstance->doUpdateByResult($this->getResultInstance());
1751 * Outputs a deprecation warning to the developer.
1753 * @param $message The message we shall output to the developer
1755 * @todo Write a logging mechanism for productive mode
1757 public function deprecationWarning ($message) {
1758 // Is developer mode active?
1759 if (defined('DEVELOPER')) {
1760 // Debug instance is there?
1761 if (!is_null($this->getDebugInstance())) {
1762 // Output stub message
1763 self::createDebugInstance(__CLASS__)->debugOutput($message);
1766 trigger_error($message . "<br />\n");
1769 // @TODO Finish this part!
1770 $this->partialStub('Developer mode inactive. Message:' . $message);
1775 * Checks whether the given PHP extension is loaded
1777 * @param $phpExtension The PHP extension we shall check
1778 * @return $isLoaded Whether the PHP extension is loaded
1780 public final function isPhpExtensionLoaded ($phpExtension) {
1782 $isLoaded = in_array($phpExtension, get_loaded_extensions());
1789 * "Getter" as a time() replacement but with milliseconds. You should use this
1790 * method instead of the encapsulated getimeofday() function.
1792 * @return $milliTime Timestamp with milliseconds
1794 public function getMilliTime () {
1795 // Get the time of day as float
1796 $milliTime = gettimeofday(true);
1803 * Idles (sleeps) for given milliseconds
1805 * @return $hasSlept Whether it goes fine
1807 public function idle ($milliSeconds) {
1808 // Sleep is fine by default
1811 // Idle so long with found function
1812 if (function_exists('time_sleep_until')) {
1813 // Get current time and add idle time
1814 $sleepUntil = $this->getMilliTime() + abs($milliSeconds) / 1000;
1816 // New PHP 5.1.0 function found, ignore errors
1817 $hasSlept = @time_sleep_until($sleepUntil);
1820 * My Sun station doesn't have that function even with latest PHP
1823 usleep($milliSeconds * 1000);
1830 * Converts a hexadecimal string, even with negative sign as first string to
1831 * a decimal number using BC functions.
1833 * This work is based on comment #86673 on php.net documentation page at:
1834 * <http://de.php.net/manual/en/function.dechex.php#86673>
1836 * @param $hex Hexadecimal string
1837 * @return $dec Decimal number
1839 protected function hex2dec ($hex) {
1840 // Convert to all lower-case
1841 $hex = strtolower($hex);
1843 // Detect sign (negative/positive numbers)
1845 if (substr($hex, 0, 1) == '-') {
1847 $hex = substr($hex, 1);
1850 // Decode the hexadecimal string into a decimal number
1852 for ($i = strlen($hex) - 1, $e = 1; $i >= 0; $i--, $e = bcmul($e, 16)) {
1853 $factor = self::$hexdec[substr($hex, $i, 1)];
1854 $dec = bcadd($dec, bcmul($factor, $e));
1857 // Return the decimal number
1858 return $sign . $dec;
1862 * Converts even very large decimal numbers, also signed, to a hexadecimal
1865 * This work is based on comment #97756 on php.net documentation page at:
1866 * <http://de.php.net/manual/en/function.hexdec.php#97756>
1868 * @param $dec Decimal number, even with negative sign
1869 * @param $maxLength Optional maximum length of the string
1870 * @return $hex Hexadecimal string
1872 protected function dec2hex ($dec, $maxLength = 0) {
1873 // maxLength can be zero or devideable by 2
1874 assert(($maxLength == 0) || (($maxLength % 2) == 0));
1876 // Detect sign (negative/positive numbers)
1883 // Encode the decimal number into a hexadecimal string
1886 $hex = self::$dechex[($dec % (2 ^ 4))] . $hex;
1888 } while ($dec >= 1);
1891 * Leading zeros are required for hex-decimal "numbers". In some
1892 * situations more leading zeros are wanted, so check for both
1895 if ($maxLength > 0) {
1896 // Prepend more zeros
1897 $hex = str_pad($hex, $maxLength, '0', STR_PAD_LEFT);
1898 } elseif ((strlen($hex) % 2) != 0) {
1899 // Only make string's length dividable by 2
1903 // Return the hexadecimal string
1904 return $sign . $hex;
1908 * Converts a ASCII string (0 to 255) into a decimal number.
1910 * @param $asc The ASCII string to be converted
1911 * @return $dec Decimal number
1913 protected function asc2dec ($asc) {
1914 // Convert it into a hexadecimal number
1915 $hex = bin2hex($asc);
1917 // And back into a decimal number
1918 $dec = $this->hex2dec($hex);
1925 * Converts a decimal number into an ASCII string.
1927 * @param $dec Decimal number
1928 * @return $asc An ASCII string
1930 protected function dec2asc ($dec) {
1931 // First convert the number into a hexadecimal string
1932 $hex = $this->dec2hex($dec);
1934 // Then convert it into the ASCII string
1935 $asc = $this->hex2asc($hex);
1942 * Converts a hexadecimal number into an ASCII string. Negative numbers
1945 * @param $hex Hexadecimal string
1946 * @return $asc An ASCII string
1948 protected function hex2asc ($hex) {
1949 // Check for length, it must be devideable by 2
1950 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('hex='.$hex);
1951 assert((strlen($hex) % 2) == 0);
1955 for ($idx = 0; $idx < strlen($hex); $idx+=2) {
1956 // Get the decimal number of the chunk
1957 $part = hexdec(substr($hex, $idx, 2));
1959 // Add it to the final string
1963 // Return the final string
1968 * Checks whether the given encoded data was encoded with Base64
1970 * @param $encodedData Encoded data we shall check
1971 * @return $isBase64 Whether the encoded data is Base64
1973 protected function isBase64Encoded ($encodedData) {
1975 $isBase64 = (@base64_decode($encodedData, true) !== FALSE);
1982 * "Getter" to get response/request type from analysis of the system.
1984 * @return $responseType Analyzed response type
1986 protected function getResponseTypeFromSystem () {
1987 // Default is console
1988 $responseType = 'console';
1990 // Is 'HTTP_HOST' set?
1991 if (isset($_SERVER['HTTP_HOST'])) {
1992 // Then it is a HTTP response/request
1993 $responseType = 'http';
1997 return $responseType;
2001 * Gets a cache key from Criteria instance
2003 * @param $criteriaInstance An instance of a Criteria class
2004 * @param $onlyKeys Only use these keys for a cache key
2005 * @return $cacheKey A cache key suitable for lookup/storage purposes
2007 protected function getCacheKeyByCriteria (Criteria $criteriaInstance, array $onlyKeys = array()) {
2009 $cacheKey = sprintf("%s@%s",
2010 $this->__toString(),
2011 $criteriaInstance->getCacheKey($onlyKeys)
2015 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . ': cacheKey=' . $cacheKey);
2020 * Getter for startup time in miliseconds
2022 * @return $startupTime Startup time in miliseconds
2024 protected function getStartupTime () {
2025 return self::$startupTime;
2029 * "Getter" for a printable currently execution time in nice braces
2031 * @return $executionTime Current execution time in nice braces
2033 protected function getPrintableExecutionTime () {
2034 // Caculate the execution time
2035 $executionTime = microtime(true) - $this->getStartupTime();
2037 // Pack it in nice braces
2038 $executionTime = sprintf('[ %01.5f ] ', $executionTime);
2041 return $executionTime;
2045 * Hashes a given string with a simple but stronger hash function (no salts)
2047 * @param $str The string to be hashed
2048 * @return $hash The hash from string $str
2050 public function hashString ($str) {
2051 // Hash given string with (better secure) hasher
2052 $hash = mhash(MHASH_SHA256, $str);
2059 * Checks whether the given number is really a number (only chars 0-9).
2061 * @param $num A string consisting only chars between 0 and 9
2062 * @param $castValue Whether to cast the value to double. Do only use this to secure numbers from Requestable classes.
2063 * @param $assertMismatch Whether to assert mismatches
2064 * @return $ret The (hopefully) secured numbered value
2066 public function bigintval ($num, $castValue = TRUE, $assertMismatch = FALSE) {
2067 // Filter all numbers out
2068 $ret = preg_replace('/[^0123456789]/', '', $num);
2071 if ($castValue === TRUE) {
2072 // Cast to biggest numeric type
2073 $ret = (double) $ret;
2076 // Assert only if requested
2077 if ($assertMismatch === TRUE) {
2078 // Has the whole value changed?
2079 assert(('' . $ret . '' != '' . $num . '') && (!is_null($num)));
2087 * Checks whether the given hexadecimal number is really a hex-number (only chars 0-9,a-f).
2089 * @param $num A string consisting only chars between 0 and 9
2090 * @param $assertMismatch Whether to assert mismatches
2091 * @return $ret The (hopefully) secured hext-numbered value
2093 public function hexval ($num, $assertMismatch = FALSE) {
2094 // Filter all numbers out
2095 $ret = preg_replace('/[^0123456789abcdefABCDEF]/', '', $num);
2097 // Assert only if requested
2098 if ($assertMismatch === TRUE) {
2099 // Has the whole value changed?
2100 assert(('' . $ret . '' != '' . $num . '') && (!is_null($num)));
2108 * Checks whether start/end marker are set
2110 * @param $data Data to be checked
2111 * @return $isset Whether start/end marker are set
2113 public final function ifStartEndMarkersSet ($data) {
2115 $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));
2117 // ... and return it
2122 * Determines if a key is set in the generic array
2124 * @param $keyGroup Main group for the key
2125 * @param $subGroup Sub group for the key
2126 * @param $key Key to check
2127 * @return $isset Whether the given key is set
2129 protected final function isGenericArrayKeySet ($keyGroup, $subGroup, $key) {
2131 $isset = isset($this->genericArray[$keyGroup][$subGroup][$key]);
2138 * Determines if an element is set in the generic array
2140 * @param $keyGroup Main group for the key
2141 * @param $subGroup Sub group for the key
2142 * @param $key Key to check
2143 * @param $element Element to check
2144 * @return $isset Whether the given key is set
2146 protected final function isGenericArrayElementSet ($keyGroup, $subGroup, $key, $element) {
2148 $isset = isset($this->genericArray[$keyGroup][$subGroup][$key][$element]);
2155 * Determines if a group is set in the generic array
2157 * @param $keyGroup Main group
2158 * @param $subGroup Sub group
2159 * @return $isset Whether the given group is set
2161 protected final function isGenericArrayGroupSet ($keyGroup, $subGroup) {
2163 $isset = isset($this->genericArray[$keyGroup][$subGroup]);
2170 * Getter for sub key group
2172 * @param $keyGroup Main key group
2173 * @param $subGroup Sub key group
2174 * @return $array An array with all array elements
2176 protected final function getGenericSubArray ($keyGroup, $subGroup) {
2178 if (!$this->isGenericArrayGroupSet($keyGroup, $subGroup)) {
2179 // No, then abort here
2180 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.');
2184 return $this->genericArray[$keyGroup][$subGroup];
2188 * Unsets a given key in generic array
2190 * @param $keyGroup Main group for the key
2191 * @param $subGroup Sub group for the key
2192 * @param $key Key to unset
2195 protected final function unsetGenericArrayElement ($keyGroup, $subGroup, $key) {
2197 unset($this->genericArray[$keyGroup][$subGroup][$key]);
2201 * Append a string to a given generic array key
2203 * @param $keyGroup Main group for the key
2204 * @param $subGroup Sub group for the key
2205 * @param $key Key to unset
2206 * @param $value Value to add/append
2209 protected final function appendStringToGenericArrayElement ($keyGroup, $subGroup, $key, $value, $appendGlue = '') {
2210 // Is it already there?
2211 if ($this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2213 $this->genericArray[$keyGroup][$subGroup][$key] .= $appendGlue . (string) $value;
2216 $this->genericArray[$keyGroup][$subGroup][$key] = (string) $value;
2221 * Initializes given generic array
2223 * @param $keyGroup Main group for the key
2224 * @param $subGroup Sub group for the key
2225 * @param $key Key to use
2228 protected final function initGenericArray ($keyGroup, $subGroup, $key) {
2229 // Is it already set?
2230 if ($this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2231 // Already initialized
2232 trigger_error(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' already initialized.');
2236 $this->genericArray[$keyGroup][$subGroup][$key] = array();
2240 * Pushes an element to a generic key
2242 * @param $keyGroup Main group for the key
2243 * @param $subGroup Sub group for the key
2244 * @param $key Key to use
2245 * @param $value Value to add/append
2246 * @return $count Number of array elements
2248 protected final function pushValueToGenericArrayElement ($keyGroup, $subGroup, $key, $value) {
2250 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2252 $this->initGenericArray($keyGroup, $subGroup, $key);
2256 //* DEBUG: */ print(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',value=' . $value . PHP_EOL);
2257 $count = array_push($this->genericArray[$keyGroup][$subGroup][$key], $value);
2260 //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE));
2261 //* DEBUG: */ print(__METHOD__ . ': count=' . $count . PHP_EOL);
2266 * Pops an element from a generic group
2268 * @param $keyGroup Main group for the key
2269 * @param $subGroup Sub group for the key
2270 * @param $key Key to unset
2271 * @return $value Last "popped" value
2273 protected final function popGenericArrayElement ($keyGroup, $subGroup, $key) {
2275 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2277 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' not found.');
2281 //* DEBUG: */ print(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' pop-ing entry ...' . PHP_EOL);
2282 $value = array_pop($this->genericArray[$keyGroup][$subGroup][$key]);
2285 //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE));
2286 //* DEBUG: */ print(__METHOD__ . ': value[' . gettype($value) . ']=' . $value . PHP_EOL);
2291 * Shifts an element from a generic group
2293 * @param $keyGroup Main group for the key
2294 * @param $subGroup Sub group for the key
2295 * @param $key Key to unset
2296 * @return $value Last "popped" value
2298 protected final function shiftGenericArrayElement ($keyGroup, $subGroup, $key) {
2300 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2302 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' not found.');
2306 //* DEBUG: */ print(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' shifting entry ...' . PHP_EOL);
2307 $value = array_shift($this->genericArray[$keyGroup][$subGroup][$key]);
2310 //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE));
2311 //* DEBUG: */ print(__METHOD__ . ': value[' . gettype($value) . ']=' . $value . PHP_EOL);
2316 * Count generic array group
2318 * @param $keyGroup Main group for the key
2319 * @return $count Count of given group
2321 protected final function countGenericArray ($keyGroup) {
2323 if (!isset($this->genericArray[$keyGroup])) {
2325 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ' not found.');
2329 $count = count($this->genericArray[$keyGroup]);
2336 * Count generic array sub group
2338 * @param $keyGroup Main group for the key
2339 * @param $subGroup Sub group for the key
2340 * @return $count Count of given group
2342 protected final function countGenericArrayGroup ($keyGroup, $subGroup) {
2344 if (!$this->isGenericArrayGroupSet($keyGroup, $subGroup)) {
2346 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.');
2350 $count = count($this->genericArray[$keyGroup][$subGroup]);
2357 * Count generic array elements
2359 * @param $keyGroup Main group for the key
2360 * @param $subGroup Sub group for the key
2361 * @para $key Key to count
2362 * @return $count Count of given key
2364 protected final function countGenericArrayElements ($keyGroup, $subGroup, $key) {
2366 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2368 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.');
2369 } elseif (!$this->isValidGenericArrayGroup($keyGroup, $subGroup)) {
2371 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' is not an array.');
2375 $count = count($this->genericArray[$keyGroup][$subGroup][$key]);
2376 //* DEBUG: */ print(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',count=' . $count . PHP_EOL);
2383 * Getter for whole generic group array
2385 * @param $keyGroup Key group to get
2386 * @return $array Whole generic array group
2388 protected final function getGenericArray ($keyGroup) {
2390 if (!isset($this->genericArray[$keyGroup])) {
2392 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ' does not exist.');
2396 return $this->genericArray[$keyGroup];
2400 * Setter for generic array key
2402 * @param $keyGroup Key group to get
2403 * @param $subGroup Sub group for the key
2404 * @param $key Key to unset
2405 * @param $value Mixed value from generic array element
2408 protected final function setGenericArrayKey ($keyGroup, $subGroup, $key, $value) {
2410 $this->genericArray[$keyGroup][$subGroup][$key] = $value;
2414 * Getter for generic array key
2416 * @param $keyGroup Key group to get
2417 * @param $subGroup Sub group for the key
2418 * @param $key Key to unset
2419 * @return $value Mixed value from generic array element
2421 protected final function getGenericArrayKey ($keyGroup, $subGroup, $key) {
2423 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2425 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' does not exist.');
2429 return $this->genericArray[$keyGroup][$subGroup][$key];
2433 * Sets a value in given generic array key/element
2435 * @param $keyGroup Main group for the key
2436 * @param $subGroup Sub group for the key
2437 * @param $key Key to set
2438 * @param $element Element to set
2439 * @param $value Value to set
2442 protected final function setGenericArrayElement ($keyGroup, $subGroup, $key, $element, $value) {
2444 $this->genericArray[$keyGroup][$subGroup][$key][$element] = $value;
2448 * Getter for generic array element
2450 * @param $keyGroup Key group to get
2451 * @param $subGroup Sub group for the key
2452 * @param $key Key to look for
2453 * @param $element Element to look for
2454 * @return $value Mixed value from generic array element
2456 protected final function getGenericArrayElement ($keyGroup, $subGroup, $key, $element) {
2458 if (!$this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element)) {
2460 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ' does not exist.');
2464 return $this->genericArray[$keyGroup][$subGroup][$key][$element];
2468 * Checks if a given sub group is valid (array)
2470 * @param $keyGroup Key group to get
2471 * @param $subGroup Sub group for the key
2472 * @return $isValid Whether given sub group is valid
2474 protected final function isValidGenericArrayGroup ($keyGroup, $subGroup) {
2476 $isValid = (($this->isGenericArrayGroupSet($keyGroup, $subGroup)) && (is_array($this->getGenericSubArray($keyGroup, $subGroup))));