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 - 2013 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 {
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.');
363 * The __call() method where all non-implemented methods end up
365 * @param $methodName Name of the missing method
366 * @args $args Arguments passed to the method
369 public final function __call ($methodName, $args) {
370 return self::__callStatic($methodName, $args);
374 * The __callStatic() method where all non-implemented static methods end up
376 * @param $methodName Name of the missing method
377 * @args $args Arguments passed to the method
380 public static final function __callStatic ($methodName, $args) {
381 // Init argument string
384 // Is it empty or an array?
387 $argsString = 'NULL';
388 } elseif (is_array($args)) {
389 // Some arguments are there
390 foreach ($args as $arg) {
391 // Add the value itself if not array. This prevents 'array to string conversion' message
392 if (is_array($arg)) {
393 $argsString .= 'Array';
398 // Add data about the argument
399 $argsString .= ' (' . gettype($arg);
401 if (is_string($arg)) {
402 // Add length for strings
403 $argsString .= ', ' . strlen($arg);
404 } elseif (is_array($arg)) {
405 // .. or size if array
406 $argsString .= ', ' . count($arg);
407 } elseif ($arg === TRUE) {
408 // ... is boolean 'TRUE'
409 $argsString .= ', TRUE';
410 } elseif ($arg === FALSE) {
411 // ... is boolean 'FALSE'
412 $argsString .= ', FALSE';
416 $argsString .= '), ';
420 if (substr($argsString, -2, 1) == ',') {
421 $argsString = substr($argsString, 0, -2);
424 // Invalid arguments!
425 $argsString = '!INVALID:' . gettype($args) . '!';
428 // Output stub message
429 // @TODO __CLASS__ does always return BaseFrameworkSystem but not the extending (=child) class
430 self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[unknown::%s:] Stub! Args: %s',
440 * Getter for $realClass
442 * @return $realClass The name of the real class (not BaseFrameworkSystem)
444 public function __toString () {
445 return $this->realClass;
449 * Magic function to catch setting of missing but set class fields/attributes
451 * @param $name Name of the field/attribute
452 * @param $value Value to store
455 public final function __set ($name, $value) {
456 $this->debugBackTrace(sprintf('Tried to set a missing field. name=%s, value[%s]=%s',
464 * Magic function to catch getting of missing fields/attributes
466 * @param $name Name of the field/attribute
469 public final function __get ($name) {
470 $this->debugBackTrace(sprintf('Tried to get a missing field. name=%s',
476 * Magic function to catch unsetting of missing fields/attributes
478 * @param $name Name of the field/attribute
481 public final function __unset ($name) {
482 $this->debugBackTrace(sprintf('Tried to unset a missing field. name=%s',
488 * Setter for the real class name
490 * @param $realClass Class name (string)
493 public final function setRealClass ($realClass) {
495 $this->realClass = (string) $realClass;
499 * Setter for database result instance
501 * @param $resultInstance An instance of a database result class
503 * @todo SearchableResult and UpdateableResult shall have a super interface to use here
505 protected final function setResultInstance (SearchableResult $resultInstance) {
506 $this->resultInstance = $resultInstance;
510 * Getter for database result instance
512 * @return $resultInstance An instance of a database result class
514 public final function getResultInstance () {
515 return $this->resultInstance;
519 * Setter for template engine instances
521 * @param $templateInstance An instance of a template engine class
524 protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
525 $this->templateInstance = $templateInstance;
529 * Getter for template engine instances
531 * @return $templateInstance An instance of a template engine class
533 protected final function getTemplateInstance () {
534 return $this->templateInstance;
538 * Setter for search instance
540 * @param $searchInstance Searchable criteria instance
543 public final function setSearchInstance (LocalSearchCriteria $searchInstance) {
544 $this->searchInstance = $searchInstance;
548 * Getter for search instance
550 * @return $searchInstance Searchable criteria instance
552 public final function getSearchInstance () {
553 return $this->searchInstance;
557 * Setter for update instance
559 * @param $updateInstance Searchable criteria instance
562 public final function setUpdateInstance (LocalUpdateCriteria $updateInstance) {
563 $this->updateInstance = $updateInstance;
567 * Getter for update instance
569 * @return $updateInstance Updateable criteria instance
571 public final function getUpdateInstance () {
572 return $this->updateInstance;
576 * Setter for resolver instance
578 * @param $resolverInstance Instance of a command resolver class
581 public final function setResolverInstance (Resolver $resolverInstance) {
582 $this->resolverInstance = $resolverInstance;
586 * Getter for resolver instance
588 * @return $resolverInstance Instance of a command resolver class
590 public final function getResolverInstance () {
591 return $this->resolverInstance;
595 * Setter for language instance
597 * @param $configInstance The configuration instance which shall
598 * be FrameworkConfiguration
601 public final function setConfigInstance (FrameworkConfiguration $configInstance) {
602 Registry::getRegistry()->addInstance('config', $configInstance);
606 * Getter for configuration instance
608 * @return $configInstance Configuration instance
610 public final function getConfigInstance () {
611 $configInstance = Registry::getRegistry()->getInstance('config');
612 return $configInstance;
616 * Setter for debug instance
618 * @param $debugInstance The instance for debug output class
621 public final function setDebugInstance (DebugMiddleware $debugInstance) {
622 Registry::getRegistry()->addInstance('debug', $debugInstance);
626 * Getter for debug instance
628 * @return $debugInstance Instance to class DebugConsoleOutput or DebugWebOutput
630 public final function getDebugInstance () {
631 // Get debug instance
632 $debugInstance = Registry::getRegistry()->getInstance('debug');
635 return $debugInstance;
639 * Setter for web output instance
641 * @param $webInstance The instance for web output class
644 public final function setWebOutputInstance (OutputStreamer $webInstance) {
645 Registry::getRegistry()->addInstance('web_output', $webInstance);
649 * Getter for web output instance
651 * @return $webOutputInstance - Instance to class WebOutput
653 public final function getWebOutputInstance () {
654 $webOutputInstance = Registry::getRegistry()->getInstance('web_output');
655 return $webOutputInstance;
659 * Setter for database instance
661 * @param $databaseInstance The instance for the database connection (forced DatabaseConnection)
664 public final function setDatabaseInstance (DatabaseConnection $databaseInstance) {
665 Registry::getRegistry()->addInstance('db_instance', $databaseInstance);
669 * Getter for database layer
671 * @return $databaseInstance The database layer instance
673 public final function getDatabaseInstance () {
675 $databaseInstance = Registry::getRegistry()->getInstance('db_instance');
678 return $databaseInstance;
682 * Setter for compressor channel
684 * @param $compressorInstance An instance of CompressorChannel
687 public final function setCompressorChannel (CompressorChannel $compressorInstance) {
688 Registry::getRegistry()->addInstance('compressor', $compressorInstance);
692 * Getter for compressor channel
694 * @return $compressorInstance The compressor channel
696 public final function getCompressorChannel () {
697 $compressorInstance = Registry::getRegistry()->getInstance('compressor');
698 return $compressorInstance;
702 * Protected getter for a manageable application helper class
704 * @return $applicationInstance An instance of a manageable application helper class
706 protected final function getApplicationInstance () {
707 $applicationInstance = Registry::getRegistry()->getInstance('application');
708 return $applicationInstance;
712 * Setter for a manageable application helper class
714 * @param $applicationInstance An instance of a manageable application helper class
717 public final function setApplicationInstance (ManageableApplication $applicationInstance) {
718 Registry::getRegistry()->addInstance('application', $applicationInstance);
722 * Setter for request instance
724 * @param $requestInstance An instance of a Requestable class
727 public final function setRequestInstance (Requestable $requestInstance) {
728 $this->requestInstance = $requestInstance;
732 * Getter for request instance
734 * @return $requestInstance An instance of a Requestable class
736 public final function getRequestInstance () {
737 return $this->requestInstance;
741 * Setter for response instance
743 * @param $responseInstance An instance of a Responseable class
746 public final function setResponseInstance (Responseable $responseInstance) {
747 $this->responseInstance = $responseInstance;
751 * Getter for response instance
753 * @return $responseInstance An instance of a Responseable class
755 public final function getResponseInstance () {
756 return $this->responseInstance;
760 * Private getter for language instance
762 * @return $langInstance An instance to the language sub-system
764 protected final function getLanguageInstance () {
765 $langInstance = Registry::getRegistry()->getInstance('language');
766 return $langInstance;
770 * Setter for language instance
772 * @param $langInstance An instance to the language sub-system
774 * @see LanguageSystem
776 public final function setLanguageInstance (ManageableLanguage $langInstance) {
777 Registry::getRegistry()->addInstance('language', $langInstance);
781 * Private getter for file IO instance
783 * @return $fileIoInstance An instance to the file I/O sub-system
785 protected final function getFileIoInstance () {
786 return $this->fileIoInstance;
790 * Setter for file I/O instance
792 * @param $fileIoInstance An instance to the file I/O sub-system
795 public final function setFileIoInstance (IoHandler $fileIoInstance) {
796 $this->fileIoInstance = $fileIoInstance;
800 * Protected setter for user instance
802 * @param $userInstance An instance of a user class
805 protected final function setUserInstance (ManageableAccount $userInstance) {
806 $this->userInstance = $userInstance;
810 * Getter for user instance
812 * @return $userInstance An instance of a user class
814 public final function getUserInstance () {
815 return $this->userInstance;
819 * Setter for controller instance (this surely breaks a bit the MVC patterm)
821 * @param $controllerInstance An instance of the controller
824 public final function setControllerInstance (Controller $controllerInstance) {
825 $this->controllerInstance = $controllerInstance;
829 * Getter for controller instance (this surely breaks a bit the MVC patterm)
831 * @return $controllerInstance An instance of the controller
833 public final function getControllerInstance () {
834 return $this->controllerInstance;
838 * Setter for RNG instance
840 * @param $rngInstance An instance of a random number generator (RNG)
843 protected final function setRngInstance (RandomNumberGenerator $rngInstance) {
844 $this->rngInstance = $rngInstance;
848 * Getter for RNG instance
850 * @return $rngInstance An instance of a random number generator (RNG)
852 public final function getRngInstance () {
853 return $this->rngInstance;
857 * Setter for Cryptable instance
859 * @param $cryptoInstance An instance of a Cryptable class
862 protected final function setCryptoInstance (Cryptable $cryptoInstance) {
863 $this->cryptoInstance = $cryptoInstance;
867 * Getter for Cryptable instance
869 * @return $cryptoInstance An instance of a Cryptable class
871 public final function getCryptoInstance () {
872 return $this->cryptoInstance;
876 * Setter for the list instance
878 * @param $listInstance A list of Listable
881 protected final function setListInstance (Listable $listInstance) {
882 $this->listInstance = $listInstance;
886 * Getter for the list instance
888 * @return $listInstance A list of Listable
890 protected final function getListInstance () {
891 return $this->listInstance;
895 * Setter for the menu instance
897 * @param $menuInstance A RenderableMenu instance
900 protected final function setMenuInstance (RenderableMenu $menuInstance) {
901 $this->menuInstance = $menuInstance;
905 * Getter for the menu instance
907 * @return $menuInstance A RenderableMenu instance
909 protected final function getMenuInstance () {
910 return $this->menuInstance;
914 * Setter for image instance
916 * @param $imageInstance An instance of an image
919 public final function setImageInstance (BaseImage $imageInstance) {
920 $this->imageInstance = $imageInstance;
924 * Getter for image instance
926 * @return $imageInstance An instance of an image
928 public final function getImageInstance () {
929 return $this->imageInstance;
933 * Setter for stacker instance
935 * @param $stackerInstance An instance of an stacker
938 public final function setStackerInstance (Stackable $stackerInstance) {
939 $this->stackerInstance = $stackerInstance;
943 * Getter for stacker instance
945 * @return $stackerInstance An instance of an stacker
947 public final function getStackerInstance () {
948 return $this->stackerInstance;
952 * Setter for compressor instance
954 * @param $compressorInstance An instance of an compressor
957 public final function setCompressorInstance (Compressor $compressorInstance) {
958 $this->compressorInstance = $compressorInstance;
962 * Getter for compressor instance
964 * @return $compressorInstance An instance of an compressor
966 public final function getCompressorInstance () {
967 return $this->compressorInstance;
971 * Setter for Parseable instance
973 * @param $parserInstance An instance of an Parseable
976 public final function setParserInstance (Parseable $parserInstance) {
977 $this->parserInstance = $parserInstance;
981 * Getter for Parseable instance
983 * @return $parserInstance An instance of an Parseable
985 public final function getParserInstance () {
986 return $this->parserInstance;
990 * Setter for ProtocolHandler instance
992 * @param $protocolInstance An instance of an ProtocolHandler
995 public final function setProtocolInstance (ProtocolHandler $protocolInstance = NULL) {
996 $this->protocolInstance = $protocolInstance;
1000 * Getter for ProtocolHandler instance
1002 * @return $protocolInstance An instance of an ProtocolHandler
1004 public final function getProtocolInstance () {
1005 return $this->protocolInstance;
1009 * Setter for DatabaseWrapper instance
1011 * @param $wrapperInstance An instance of an DatabaseWrapper
1014 public final function setWrapperInstance (DatabaseWrapper $wrapperInstance) {
1015 $this->wrapperInstance = $wrapperInstance;
1019 * Getter for DatabaseWrapper instance
1021 * @return $wrapperInstance An instance of an DatabaseWrapper
1023 public final function getWrapperInstance () {
1024 return $this->wrapperInstance;
1028 * Setter for socket resource
1030 * @param $socketResource A valid socket resource
1033 public final function setSocketResource ($socketResource) {
1034 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': socketResource=' . $socketResource . ',previous[' . gettype($this->socketResource) . ']=' . $this->socketResource);
1035 $this->socketResource = $socketResource;
1039 * Getter for socket resource
1041 * @return $socketResource A valid socket resource
1043 public final function getSocketResource () {
1044 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': socketResource[' . gettype($this->socketResource) . ']=' . $this->socketResource);
1045 return $this->socketResource;
1049 * Setter for helper instance
1051 * @param $helperInstance An instance of a helper class
1054 protected final function setHelperInstance (Helper $helperInstance) {
1055 $this->helperInstance = $helperInstance;
1059 * Getter for helper instance
1061 * @return $helperInstance An instance of a helper class
1063 public final function getHelperInstance () {
1064 return $this->helperInstance;
1068 * Setter for a Sourceable instance
1070 * @param $sourceInstance The Sourceable instance
1073 protected final function setSourceInstance (Sourceable $sourceInstance) {
1074 $this->sourceInstance = $sourceInstance;
1078 * Getter for a Sourceable instance
1080 * @return $sourceInstance The Sourceable instance
1082 protected final function getSourceInstance () {
1083 return $this->sourceInstance;
1087 * Getter for a InputStreamable instance
1089 * @param $inputStreamInstance The InputStreamable instance
1091 protected final function getInputStreamInstance () {
1092 return $this->inputStreamInstance;
1096 * Setter for a InputStreamable instance
1098 * @param $inputStreamInstance The InputStreamable instance
1101 protected final function setInputStreamInstance (InputStreamable $inputStreamInstance) {
1102 $this->inputStreamInstance = $inputStreamInstance;
1106 * Getter for a OutputStreamable instance
1108 * @param $outputStreamInstance The OutputStreamable instance
1110 protected final function getOutputStreamInstance () {
1111 return $this->outputStreamInstance;
1115 * Setter for a OutputStreamable instance
1117 * @param $outputStreamInstance The OutputStreamable instance
1120 protected final function setOutputStreamInstance (OutputStreamable $outputStreamInstance) {
1121 $this->outputStreamInstance = $outputStreamInstance;
1125 * Setter for handler instance
1127 * @param $handlerInstance An instance of a Handleable class
1130 protected final function setHandlerInstance (Handleable $handlerInstance) {
1131 $this->handlerInstance = $handlerInstance;
1135 * Getter for handler instance
1137 * @return $handlerInstance A Networkable instance
1139 protected final function getHandlerInstance () {
1140 return $this->handlerInstance;
1144 * Setter for visitor instance
1146 * @param $visitorInstance A Visitor instance
1149 protected final function setVisitorInstance (Visitor $visitorInstance) {
1150 $this->visitorInstance = $visitorInstance;
1154 * Getter for visitor instance
1156 * @return $visitorInstance A Visitor instance
1158 protected final function getVisitorInstance () {
1159 return $this->visitorInstance;
1163 * Setter for DHT instance
1165 * @param $dhtInstance A Distributable instance
1168 protected final function setDhtInstance (Distributable $dhtInstance) {
1169 $this->dhtInstance = $dhtInstance;
1173 * Getter for DHT instance
1175 * @return $dhtInstance A Distributable instance
1177 protected final function getDhtInstance () {
1178 return $this->dhtInstance;
1182 * Setter for raw package Data
1184 * @param $packageData Raw package Data
1187 public final function setPackageData (array $packageData) {
1188 $this->packageData = $packageData;
1192 * Getter for raw package Data
1194 * @return $packageData Raw package Data
1196 public function getPackageData () {
1197 return $this->packageData;
1202 * Setter for Iterator instance
1204 * @param $iteratorInstance An instance of an Iterator
1207 protected final function setIteratorInstance (Iterator $iteratorInstance) {
1208 $this->iteratorInstance = $iteratorInstance;
1212 * Getter for Iterator instance
1214 * @return $iteratorInstance An instance of an Iterator
1216 public final function getIteratorInstance () {
1217 return $this->iteratorInstance;
1221 * Checks whether an object equals this object. You should overwrite this
1222 * method to implement own equality checks
1224 * @param $objectInstance An instance of a FrameworkInterface object
1225 * @return $equals Whether both objects equals
1227 public function equals (FrameworkInterface $objectInstance) {
1230 $this->__toString() == $objectInstance->__toString()
1232 $this->hashCode() == $objectInstance->hashCode()
1235 // Return the result
1240 * Generates a generic hash code of this class. You should really overwrite
1241 * this method with your own hash code generator code. But keep KISS in mind.
1243 * @return $hashCode A generic hash code respresenting this whole class
1245 public function hashCode () {
1247 return crc32($this->__toString());
1251 * Formats computer generated price values into human-understandable formats
1252 * with thousand and decimal separators.
1254 * @param $value The in computer format value for a price
1255 * @param $currency The currency symbol (use HTML-valid characters!)
1256 * @param $decNum Number of decimals after commata
1257 * @return $price The for the current language formated price string
1258 * @throws MissingDecimalsThousandsSeparatorException If decimals or
1259 * thousands separator
1262 public function formatCurrency ($value, $currency = '€', $decNum = 2) {
1263 // Are all required attriutes set?
1264 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
1265 // Throw an exception
1266 throw new MissingDecimalsThousandsSeparatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
1270 $value = (float) $value;
1272 // Reformat the US number
1273 $price = number_format($value, $decNum, $this->decimals, $this->thousands) . $currency;
1275 // Return as string...
1280 * Appends a trailing slash to a string
1282 * @param $str A string (maybe) without trailing slash
1283 * @return $str A string with an auto-appended trailing slash
1285 public final function addMissingTrailingSlash ($str) {
1286 // Is there a trailing slash?
1287 if (substr($str, -1, 1) != '/') {
1291 // Return string with trailing slash
1296 * Prepare the template engine (WebTemplateEngine by default) for a given
1297 * application helper instance (ApplicationHelper by default).
1299 * @param $applicationInstance An application helper instance or
1300 * null if we shall use the default
1301 * @return $templateInstance The template engine instance
1302 * @throws NullPointerException If the discovered application
1303 * instance is still null
1305 protected function prepareTemplateInstance (ManageableApplication $applicationInstance = NULL) {
1306 // Is the application instance set?
1307 if (is_null($applicationInstance)) {
1308 // Get the current instance
1309 $applicationInstance = $this->getApplicationInstance();
1312 if (is_null($applicationInstance)) {
1313 // Thrown an exception
1314 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1318 // Initialize the template engine
1319 $templateInstance = ObjectFactory::createObjectByConfiguredName('web_template_class');
1321 // Return the prepared instance
1322 return $templateInstance;
1326 * Debugs this instance by putting out it's full content
1328 * @param $message Optional message to show in debug output
1331 public final function debugInstance ($message = '') {
1332 // Restore the error handler to avoid trouble with missing array elements or undeclared variables
1333 restore_error_handler();
1338 // Is a message set?
1339 if (!empty($message)) {
1340 // Construct message
1341 $content = sprintf('<div class="debug_message">Message: %s</div>' . PHP_EOL, $message);
1344 // Generate the output
1345 $content .= sprintf('<pre>%s</pre>',
1348 print_r($this, TRUE)
1354 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>',
1355 $this->__toString(),
1357 ClassLoader::getSelfInstance()->getPrintableIncludeList()
1362 * Replaces control characters with printable output
1364 * @param $str String with control characters
1365 * @return $str Replaced string
1367 protected function replaceControlCharacters ($str) {
1370 chr(13), '[r]', str_replace(
1371 chr(10), '[n]', str_replace(
1381 * Output a partial stub message for the caller method
1383 * @param $message An optional message to display
1386 protected function partialStub ($message = '') {
1387 // Get the backtrace
1388 $backtrace = debug_backtrace();
1390 // Generate the class::method string
1391 $methodName = 'UnknownClass->unknownMethod';
1392 if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
1393 $methodName = $backtrace[1]['class'] . '->' . $backtrace[1]['function'];
1396 // Construct the full message
1397 $stubMessage = sprintf('[%s:] Partial stub!',
1401 // Is the extra message given?
1402 if (!empty($message)) {
1403 // Then add it as well
1404 $stubMessage .= ' Message: ' . $message;
1407 // Debug instance is there?
1408 if (!is_null($this->getDebugInstance())) {
1409 // Output stub message
1410 self::createDebugInstance(__CLASS__)->debugOutput($stubMessage);
1413 trigger_error($stubMessage);
1419 * Outputs a debug backtrace and stops further script execution
1421 * @param $message An optional message to output
1422 * @param $doExit Whether exit the program (TRUE is default)
1425 public function debugBackTrace ($message = '', $doExit = TRUE) {
1426 // Sorry, there is no other way getting this nice backtrace
1427 if (!empty($message)) {
1429 printf('Message: %s<br />' . chr(10), $message);
1433 debug_print_backtrace();
1437 if ($doExit === TRUE) {
1443 * Creates an instance of a debugger instance
1445 * @param $className Name of the class (currently unsupported)
1446 * @return $debugInstance An instance of a debugger class
1448 public final static function createDebugInstance ($className) {
1449 // Is the instance set?
1450 if (!Registry::getRegistry()->instanceExists('debug')) {
1451 // Init debug instance
1452 $debugInstance = NULL;
1456 // Get a debugger instance
1457 $debugInstance = DebugMiddleware::createDebugMiddleware(FrameworkConfiguration::getSelfInstance()->getConfigEntry('debug_class'));
1458 } catch (NullPointerException $e) {
1459 // Didn't work, no instance there
1460 exit('Cannot create debugInstance! Exception=' . $e->__toString() . ', message=' . $e->getMessage());
1463 // Empty string should be ignored and used for testing the middleware
1464 DebugMiddleware::getSelfInstance()->output('');
1466 // Set it in its own class. This will set it in the registry
1467 $debugInstance->setDebugInstance($debugInstance);
1469 // Get instance from registry
1470 $debugInstance = Registry::getRegistry()->getDebugInstance();
1474 return $debugInstance;
1478 * Simple output of a message with line-break
1480 * @param $message Message to output
1483 public function outputLine ($message) {
1485 print($message . PHP_EOL);
1489 * Outputs a debug message whether to debug instance (should be set!) or
1490 * dies with or ptints the message. Do NEVER EVER rewrite the exit() call to
1491 * ApplicationEntryPoint::app_exit(), this would cause an endless loop.
1493 * @param $message Message we shall send out...
1494 * @param $doPrint Whether print or die here (default: print)
1495 * @paran $stripTags Whether to strip tags (default: FALSE)
1498 public function debugOutput ($message, $doPrint = TRUE, $stripTags = FALSE) {
1499 // Set debug instance to NULL
1500 $debugInstance = NULL;
1504 // Get debug instance
1505 $debugInstance = $this->getDebugInstance();
1506 } catch (NullPointerException $e) {
1507 // The debug instance is not set (yet)
1510 // Is the debug instance there?
1511 if (is_object($debugInstance)) {
1512 // Use debug output handler
1513 $debugInstance->output($message, $stripTags);
1515 if ($doPrint === FALSE) {
1516 // Die here if not printed
1520 // Are debug times enabled?
1521 if ($this->getConfigInstance()->getConfigEntry('debug_output_timings') == 'Y') {
1523 $message = $this->getPrintableExecutionTime() . $message;
1527 if ($doPrint === TRUE) {
1529 $this->outputLine($message);
1538 * Converts e.g. a command from URL to a valid class by keeping out bad characters
1540 * @param $str The string, what ever it is needs to be converted
1541 * @return $className Generated class name
1543 public function convertToClassName ($str) {
1547 // Convert all dashes in underscores
1548 $str = $this->convertDashesToUnderscores($str);
1550 // Now use that underscores to get classname parts for hungarian style
1551 foreach (explode('_', $str) as $strPart) {
1552 // Make the class name part lower case and first upper case
1553 $className .= ucfirst(strtolower($strPart));
1556 // Return class name
1561 * Converts dashes to underscores, e.g. useable for configuration entries
1563 * @param $str The string with maybe dashes inside
1564 * @return $str The converted string with no dashed, but underscores
1566 public final function convertDashesToUnderscores ($str) {
1568 $str = str_replace('-', '_', $str);
1570 // Return converted string
1575 * Marks up the code by adding e.g. line numbers
1577 * @param $phpCode Unmarked PHP code
1578 * @return $markedCode Marked PHP code
1580 public function markupCode ($phpCode) {
1585 $errorArray = error_get_last();
1587 // Init the code with error message
1588 if (is_array($errorArray)) {
1590 $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>',
1591 basename($errorArray['file']),
1592 $errorArray['line'],
1593 $errorArray['message'],
1598 // Add line number to the code
1599 foreach (explode(chr(10), $phpCode) as $lineNo => $code) {
1601 $markedCode .= sprintf('<span id="code_line">%s</span>: %s' . chr(10),
1603 htmlentities($code, ENT_QUOTES)
1612 * Filter a given GMT timestamp (non Uni* stamp!) to make it look more
1613 * beatiful for web-based front-ends. If null is given a message id
1614 * null_timestamp will be resolved and returned.
1616 * @param $timestamp Timestamp to prepare (filter) for display
1617 * @return $readable A readable timestamp
1619 public function doFilterFormatTimestamp ($timestamp) {
1620 // Default value to return
1623 // Is the timestamp null?
1624 if (is_null($timestamp)) {
1625 // Get a message string
1626 $readable = $this->getLanguageInstance()->getMessage('null_timestamp');
1628 switch ($this->getLanguageInstance()->getLanguageCode()) {
1629 case 'de': // German format is a bit different to default
1630 // Split the GMT stamp up
1631 $dateTime = explode(' ', $timestamp );
1632 $dateArray = explode('-', $dateTime[0]);
1633 $timeArray = explode(':', $dateTime[1]);
1635 // Construct the timestamp
1636 $readable = sprintf($this->getConfigInstance()->getConfigEntry('german_date_time'),
1646 default: // Default is pass-through
1647 $readable = $timestamp;
1657 * Filter a given number into a localized number
1659 * @param $value The raw value from e.g. database
1660 * @return $localized Localized value
1662 public function doFilterFormatNumber ($value) {
1663 // Generate it from config and localize dependencies
1664 switch ($this->getLanguageInstance()->getLanguageCode()) {
1665 case 'de': // German format is a bit different to default
1666 $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), ',', '.');
1669 default: // US, etc.
1670 $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), '.', ',');
1679 * "Getter" for databse entry
1681 * @return $entry An array with database entries
1682 * @throws NullPointerException If the database result is not found
1683 * @throws InvalidDatabaseResultException If the database result is invalid
1685 protected final function getDatabaseEntry () {
1686 // Is there an instance?
1687 if (is_null($this->getResultInstance())) {
1688 // Throw an exception here
1689 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1693 $this->getResultInstance()->rewind();
1695 // Do we have an entry?
1696 if ($this->getResultInstance()->valid() === FALSE) {
1697 throw new InvalidDatabaseResultException(array($this, $this->getResultInstance()), DatabaseResult::EXCEPTION_INVALID_DATABASE_RESULT);
1701 $this->getResultInstance()->next();
1704 $entry = $this->getResultInstance()->current();
1711 * Getter for field name
1713 * @param $fieldName Field name which we shall get
1714 * @return $fieldValue Field value from the user
1715 * @throws NullPointerException If the result instance is null
1717 public final function getField ($fieldName) {
1718 // Default field value
1721 // Get result instance
1722 $resultInstance = $this->getResultInstance();
1724 // Is this instance null?
1725 if (is_null($resultInstance)) {
1726 // Then the user instance is no longer valid (expired cookies?)
1727 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1730 // Get current array
1731 $fieldArray = $resultInstance->current();
1732 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($fieldName.':<pre>'.print_r($fieldArray, TRUE).'</pre>');
1734 // Convert dashes to underscore
1735 $fieldName = $this->convertDashesToUnderscores($fieldName);
1737 // Does the field exist?
1738 if (isset($fieldArray[$fieldName])) {
1740 $fieldValue = $fieldArray[$fieldName];
1742 // Missing field entry, may require debugging
1743 self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . ':fieldname=' . $fieldName . ' not found!');
1751 * Flushs all pending updates to the database layer
1755 public function flushPendingUpdates () {
1756 // Get result instance
1757 $resultInstance = $this->getResultInstance();
1759 // Do we have data to update?
1760 if ((is_object($resultInstance)) && ($resultInstance->ifDataNeedsFlush())) {
1761 // Get wrapper class name config entry
1762 $configEntry = $resultInstance->getUpdateInstance()->getWrapperConfigEntry();
1764 // Create object instance
1765 $wrapperInstance = ObjectFactory::createObjectByConfiguredName($configEntry);
1767 // Yes, then send the whole result to the database layer
1768 $wrapperInstance->doUpdateByResult($this->getResultInstance());
1773 * Outputs a deprecation warning to the developer.
1775 * @param $message The message we shall output to the developer
1777 * @todo Write a logging mechanism for productive mode
1779 public function deprecationWarning ($message) {
1780 // Is developer mode active?
1781 if (defined('DEVELOPER')) {
1782 // Debug instance is there?
1783 if (!is_null($this->getDebugInstance())) {
1784 // Output stub message
1785 self::createDebugInstance(__CLASS__)->debugOutput($message);
1788 trigger_error($message . "<br />\n");
1792 // @TODO Finish this part!
1793 $this->partialStub('Developer mode inactive. Message:' . $message);
1798 * Checks whether the given PHP extension is loaded
1800 * @param $phpExtension The PHP extension we shall check
1801 * @return $isLoaded Whether the PHP extension is loaded
1803 public final function isPhpExtensionLoaded ($phpExtension) {
1805 $isLoaded = in_array($phpExtension, get_loaded_extensions());
1812 * "Getter" as a time() replacement but with milliseconds. You should use this
1813 * method instead of the encapsulated getimeofday() function.
1815 * @return $milliTime Timestamp with milliseconds
1817 public function getMilliTime () {
1818 // Get the time of day as float
1819 $milliTime = gettimeofday(TRUE);
1826 * Idles (sleeps) for given milliseconds
1828 * @return $hasSlept Whether it goes fine
1830 public function idle ($milliSeconds) {
1831 // Sleep is fine by default
1834 // Idle so long with found function
1835 if (function_exists('time_sleep_until')) {
1836 // Get current time and add idle time
1837 $sleepUntil = $this->getMilliTime() + abs($milliSeconds) / 1000;
1839 // New PHP 5.1.0 function found, ignore errors
1840 $hasSlept = @time_sleep_until($sleepUntil);
1843 * My Sun station doesn't have that function even with latest PHP
1846 usleep($milliSeconds * 1000);
1853 * Converts a hexadecimal string, even with negative sign as first string to
1854 * a decimal number using BC functions.
1856 * This work is based on comment #86673 on php.net documentation page at:
1857 * <http://de.php.net/manual/en/function.dechex.php#86673>
1859 * @param $hex Hexadecimal string
1860 * @return $dec Decimal number
1862 protected function hex2dec ($hex) {
1863 // Convert to all lower-case
1864 $hex = strtolower($hex);
1866 // Detect sign (negative/positive numbers)
1868 if (substr($hex, 0, 1) == '-') {
1870 $hex = substr($hex, 1);
1873 // Decode the hexadecimal string into a decimal number
1875 for ($i = strlen($hex) - 1, $e = 1; $i >= 0; $i--, $e = bcmul($e, 16)) {
1876 $factor = self::$hexdec[substr($hex, $i, 1)];
1877 $dec = bcadd($dec, bcmul($factor, $e));
1880 // Return the decimal number
1881 return $sign . $dec;
1885 * Converts even very large decimal numbers, also signed, to a hexadecimal
1888 * This work is based on comment #97756 on php.net documentation page at:
1889 * <http://de.php.net/manual/en/function.hexdec.php#97756>
1891 * @param $dec Decimal number, even with negative sign
1892 * @param $maxLength Optional maximum length of the string
1893 * @return $hex Hexadecimal string
1895 protected function dec2hex ($dec, $maxLength = 0) {
1896 // maxLength can be zero or devideable by 2
1897 assert(($maxLength == 0) || (($maxLength % 2) == 0));
1899 // Detect sign (negative/positive numbers)
1906 // Encode the decimal number into a hexadecimal string
1909 $hex = self::$dechex[($dec % (2 ^ 4))] . $hex;
1911 } while ($dec >= 1);
1914 * Leading zeros are required for hex-decimal "numbers". In some
1915 * situations more leading zeros are wanted, so check for both
1918 if ($maxLength > 0) {
1919 // Prepend more zeros
1920 $hex = str_pad($hex, $maxLength, '0', STR_PAD_LEFT);
1921 } elseif ((strlen($hex) % 2) != 0) {
1922 // Only make string's length dividable by 2
1926 // Return the hexadecimal string
1927 return $sign . $hex;
1931 * Converts a ASCII string (0 to 255) into a decimal number.
1933 * @param $asc The ASCII string to be converted
1934 * @return $dec Decimal number
1936 protected function asc2dec ($asc) {
1937 // Convert it into a hexadecimal number
1938 $hex = bin2hex($asc);
1940 // And back into a decimal number
1941 $dec = $this->hex2dec($hex);
1948 * Converts a decimal number into an ASCII string.
1950 * @param $dec Decimal number
1951 * @return $asc An ASCII string
1953 protected function dec2asc ($dec) {
1954 // First convert the number into a hexadecimal string
1955 $hex = $this->dec2hex($dec);
1957 // Then convert it into the ASCII string
1958 $asc = $this->hex2asc($hex);
1965 * Converts a hexadecimal number into an ASCII string. Negative numbers
1968 * @param $hex Hexadecimal string
1969 * @return $asc An ASCII string
1971 protected function hex2asc ($hex) {
1972 // Check for length, it must be devideable by 2
1973 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('hex='.$hex);
1974 assert((strlen($hex) % 2) == 0);
1978 for ($idx = 0; $idx < strlen($hex); $idx+=2) {
1979 // Get the decimal number of the chunk
1980 $part = hexdec(substr($hex, $idx, 2));
1982 // Add it to the final string
1986 // Return the final string
1991 * Checks whether the given encoded data was encoded with Base64
1993 * @param $encodedData Encoded data we shall check
1994 * @return $isBase64 Whether the encoded data is Base64
1996 protected function isBase64Encoded ($encodedData) {
1998 $isBase64 = (@base64_decode($encodedData, TRUE) !== FALSE);
2005 * "Getter" to get response/request type from analysis of the system.
2007 * @return $responseType Analyzed response type
2009 protected function getResponseTypeFromSystem () {
2010 // Default is console
2011 $responseType = 'console';
2013 // Is 'HTTP_HOST' set?
2014 if (isset($_SERVER['HTTP_HOST'])) {
2015 // Then it is a HTTP response/request
2016 $responseType = 'http';
2020 return $responseType;
2024 * Gets a cache key from Criteria instance
2026 * @param $criteriaInstance An instance of a Criteria class
2027 * @param $onlyKeys Only use these keys for a cache key
2028 * @return $cacheKey A cache key suitable for lookup/storage purposes
2030 protected function getCacheKeyByCriteria (Criteria $criteriaInstance, array $onlyKeys = array()) {
2032 $cacheKey = sprintf('%s@%s',
2033 $this->__toString(),
2034 $criteriaInstance->getCacheKey($onlyKeys)
2038 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . ': cacheKey=' . $cacheKey);
2043 * Getter for startup time in miliseconds
2045 * @return $startupTime Startup time in miliseconds
2047 protected function getStartupTime () {
2048 return self::$startupTime;
2052 * "Getter" for a printable currently execution time in nice braces
2054 * @return $executionTime Current execution time in nice braces
2056 protected function getPrintableExecutionTime () {
2057 // Caculate the execution time
2058 $executionTime = microtime(TRUE) - $this->getStartupTime();
2060 // Pack it in nice braces
2061 $executionTime = sprintf('[ %01.5f ] ', $executionTime);
2064 return $executionTime;
2068 * Hashes a given string with a simple but stronger hash function (no salts)
2070 * @param $str The string to be hashed
2071 * @return $hash The hash from string $str
2073 public function hashString ($str) {
2074 // Hash given string with (better secure) hasher
2075 $hash = mhash(MHASH_SHA256, $str);
2082 * Checks whether the given number is really a number (only chars 0-9).
2084 * @param $num A string consisting only chars between 0 and 9
2085 * @param $castValue Whether to cast the value to double. Do only use this to secure numbers from Requestable classes.
2086 * @param $assertMismatch Whether to assert mismatches
2087 * @return $ret The (hopefully) secured numbered value
2089 public function bigintval ($num, $castValue = TRUE, $assertMismatch = FALSE) {
2090 // Filter all numbers out
2091 $ret = preg_replace('/[^0123456789]/', '', $num);
2094 if ($castValue === TRUE) {
2095 // Cast to biggest numeric type
2096 $ret = (double) $ret;
2099 // Assert only if requested
2100 if ($assertMismatch === TRUE) {
2101 // Has the whole value changed?
2102 assert(('' . $ret . '' != '' . $num . '') && (!is_null($num)));
2110 * Checks whether the given hexadecimal number is really a hex-number (only chars 0-9,a-f).
2112 * @param $num A string consisting only chars between 0 and 9
2113 * @param $assertMismatch Whether to assert mismatches
2114 * @return $ret The (hopefully) secured hext-numbered value
2116 public function hexval ($num, $assertMismatch = FALSE) {
2117 // Filter all numbers out
2118 $ret = preg_replace('/[^0123456789abcdefABCDEF]/', '', $num);
2120 // Assert only if requested
2121 if ($assertMismatch === TRUE) {
2122 // Has the whole value changed?
2123 assert(('' . $ret . '' != '' . $num . '') && (!is_null($num)));
2131 * Checks whether start/end marker are set
2133 * @param $data Data to be checked
2134 * @return $isset Whether start/end marker are set
2136 public final function ifStartEndMarkersSet ($data) {
2138 $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));
2140 // ... and return it
2145 * Determines if an element is set in the generic array
2147 * @param $keyGroup Main group for the key
2148 * @param $subGroup Sub group for the key
2149 * @param $key Key to check
2150 * @param $element Element to check
2151 * @return $isset Whether the given key is set
2153 protected final function isGenericArrayElementSet ($keyGroup, $subGroup, $key, $element) {
2155 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element);
2158 $isset = isset($this->genericArray[$keyGroup][$subGroup][$key][$element]);
2164 * Determines if a key is set in the generic array
2166 * @param $keyGroup Main group for the key
2167 * @param $subGroup Sub group for the key
2168 * @param $key Key to check
2169 * @return $isset Whether the given key is set
2171 protected final function isGenericArrayKeySet ($keyGroup, $subGroup, $key) {
2173 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2176 $isset = isset($this->genericArray[$keyGroup][$subGroup][$key]);
2184 * Determines if a group is set in the generic array
2186 * @param $keyGroup Main group
2187 * @param $subGroup Sub group
2188 * @return $isset Whether the given group is set
2190 protected final function isGenericArrayGroupSet ($keyGroup, $subGroup) {
2192 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup);
2195 $isset = isset($this->genericArray[$keyGroup][$subGroup]);
2202 * Getter for sub key group
2204 * @param $keyGroup Main key group
2205 * @param $subGroup Sub key group
2206 * @return $array An array with all array elements
2208 protected final function getGenericSubArray ($keyGroup, $subGroup) {
2210 if (!$this->isGenericArrayGroupSet($keyGroup, $subGroup)) {
2211 // No, then abort here
2212 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.');
2217 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',value=' . print_r($this->genericArray[$keyGroup][$subGroup], TRUE));
2220 return $this->genericArray[$keyGroup][$subGroup];
2224 * Unsets a given key in generic array
2226 * @param $keyGroup Main group for the key
2227 * @param $subGroup Sub group for the key
2228 * @param $key Key to unset
2231 protected final function unsetGenericArrayKey ($keyGroup, $subGroup, $key) {
2233 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2236 unset($this->genericArray[$keyGroup][$subGroup][$key]);
2240 * Unsets a given element in generic array
2242 * @param $keyGroup Main group for the key
2243 * @param $subGroup Sub group for the key
2244 * @param $key Key to unset
2245 * @param $element Element to unset
2248 protected final function unsetGenericArrayElement ($keyGroup, $subGroup, $key, $element) {
2250 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element);
2253 unset($this->genericArray[$keyGroup][$subGroup][$key][$element]);
2257 * Append a string to a given generic array key
2259 * @param $keyGroup Main group for the key
2260 * @param $subGroup Sub group for the key
2261 * @param $key Key to unset
2262 * @param $value Value to add/append
2265 protected final function appendStringToGenericArrayKey ($keyGroup, $subGroup, $key, $value, $appendGlue = '') {
2267 //* 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);
2269 // Is it already there?
2270 if ($this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2272 $this->genericArray[$keyGroup][$subGroup][$key] .= $appendGlue . (string) $value;
2275 $this->genericArray[$keyGroup][$subGroup][$key] = (string) $value;
2280 * Append a string to a given generic array element
2282 * @param $keyGroup Main group for the key
2283 * @param $subGroup Sub group for the key
2284 * @param $key Key to unset
2285 * @param $element Element to check
2286 * @param $value Value to add/append
2289 protected final function appendStringToGenericArrayElement ($keyGroup, $subGroup, $key, $element, $value, $appendGlue = '') {
2291 //* 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);
2293 // Is it already there?
2294 if ($this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element)) {
2296 $this->genericArray[$keyGroup][$subGroup][$key][$element] .= $appendGlue . (string) $value;
2299 $this->genericArray[$keyGroup][$subGroup][$key][$element] = (string) $value;
2304 * Initializes given generic array group
2306 * @param $keyGroup Main group for the key
2307 * @param $subGroup Sub group for the key
2308 * @param $key Key to use
2309 * @param $forceInit Optionally force initialization
2312 protected final function initGenericArrayGroup ($keyGroup, $subGroup, $forceInit = FALSE) {
2314 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',forceInit=' . intval($forceInit));
2316 // Is it already set?
2317 if (($forceInit === FALSE) && ($this->isGenericArrayGroupSet($keyGroup, $subGroup))) {
2318 // Already initialized
2319 trigger_error(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' already initialized.');
2324 $this->genericArray[$keyGroup][$subGroup] = array();
2328 * Initializes given generic array key
2330 * @param $keyGroup Main group for the key
2331 * @param $subGroup Sub group for the key
2332 * @param $key Key to use
2333 * @param $forceInit Optionally force initialization
2336 protected final function initGenericArrayKey ($keyGroup, $subGroup, $key, $forceInit = FALSE) {
2338 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',forceInit=' . intval($forceInit));
2340 // Is it already set?
2341 if (($forceInit === FALSE) && ($this->isGenericArrayKeySet($keyGroup, $subGroup, $key))) {
2342 // Already initialized
2343 trigger_error(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' already initialized.');
2348 $this->genericArray[$keyGroup][$subGroup][$key] = array();
2352 * Initializes given generic array element
2354 * @param $keyGroup Main group for the key
2355 * @param $subGroup Sub group for the key
2356 * @param $key Key to use
2357 * @param $element Element to use
2358 * @param $forceInit Optionally force initialization
2361 protected final function initGenericArrayElement ($keyGroup, $subGroup, $key, $element, $forceInit = FALSE) {
2363 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',forceInit=' . intval($forceInit));
2365 // Is it already set?
2366 if (($forceInit === FALSE) && ($this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element))) {
2367 // Already initialized
2368 trigger_error(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ' already initialized.');
2373 $this->genericArray[$keyGroup][$subGroup][$key][$element] = array();
2377 * Pushes an element to a generic key
2379 * @param $keyGroup Main group for the key
2380 * @param $subGroup Sub group for the key
2381 * @param $key Key to use
2382 * @param $value Value to add/append
2383 * @return $count Number of array elements
2385 protected final function pushValueToGenericArrayKey ($keyGroup, $subGroup, $key, $value) {
2387 //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',value[' . gettype($value) . ']=' . print_r($value, TRUE));
2390 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2392 $this->initGenericArrayKey($keyGroup, $subGroup, $key);
2396 $count = array_push($this->genericArray[$keyGroup][$subGroup][$key], $value);
2399 //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE));
2400 //* DEBUG: */ print(__METHOD__ . ': count=' . $count . PHP_EOL);
2405 * Pushes an element to a generic array element
2407 * @param $keyGroup Main group for the key
2408 * @param $subGroup Sub group for the key
2409 * @param $key Key to use
2410 * @param $element Element to check
2411 * @param $value Value to add/append
2412 * @return $count Number of array elements
2414 protected final function pushValueToGenericArrayElement ($keyGroup, $subGroup, $key, $element, $value) {
2416 //* 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));
2419 if (!$this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element)) {
2421 $this->initGenericArrayElement($keyGroup, $subGroup, $key, $element);
2425 $count = array_push($this->genericArray[$keyGroup][$subGroup][$key][$element], $value);
2428 //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE));
2429 //* DEBUG: */ print(__METHOD__ . ': count=' . $count . PHP_EOL);
2434 * Pops an element from a generic group
2436 * @param $keyGroup Main group for the key
2437 * @param $subGroup Sub group for the key
2438 * @param $key Key to unset
2439 * @return $value Last "popped" value
2441 protected final function popGenericArrayElement ($keyGroup, $subGroup, $key) {
2443 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2446 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2448 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' not found.');
2453 $value = array_pop($this->genericArray[$keyGroup][$subGroup][$key]);
2456 //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE));
2457 //* DEBUG: */ print(__METHOD__ . ': value[' . gettype($value) . ']=' . print_r($value, TRUE) . PHP_EOL);
2462 * Shifts an element from a generic group
2464 * @param $keyGroup Main group for the key
2465 * @param $subGroup Sub group for the key
2466 * @param $key Key to unset
2467 * @return $value Last "popped" value
2469 protected final function shiftGenericArrayElement ($keyGroup, $subGroup, $key) {
2471 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2474 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2476 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' not found.');
2481 $value = array_shift($this->genericArray[$keyGroup][$subGroup][$key]);
2484 //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE));
2485 //* DEBUG: */ print(__METHOD__ . ': value[' . gettype($value) . ']=' . print_r($value, TRUE) . PHP_EOL);
2490 * Count generic array group
2492 * @param $keyGroup Main group for the key
2493 * @return $count Count of given group
2495 protected final function countGenericArray ($keyGroup) {
2497 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup);
2500 if (!isset($this->genericArray[$keyGroup])) {
2502 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ' not found.');
2507 $count = count($this->genericArray[$keyGroup]);
2510 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',count=' . $count);
2517 * Count generic array sub group
2519 * @param $keyGroup Main group for the key
2520 * @param $subGroup Sub group for the key
2521 * @return $count Count of given group
2523 protected final function countGenericArrayGroup ($keyGroup, $subGroup) {
2525 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup);
2528 if (!$this->isGenericArrayGroupSet($keyGroup, $subGroup)) {
2530 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.');
2535 $count = count($this->genericArray[$keyGroup][$subGroup]);
2538 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',count=' . $count);
2545 * Count generic array elements
2547 * @param $keyGroup Main group for the key
2548 * @param $subGroup Sub group for the key
2549 * @para $key Key to count
2550 * @return $count Count of given key
2552 protected final function countGenericArrayElements ($keyGroup, $subGroup, $key) {
2554 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2557 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2559 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.');
2561 } elseif (!$this->isValidGenericArrayGroup($keyGroup, $subGroup)) {
2563 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' is not an array.');
2568 $count = count($this->genericArray[$keyGroup][$subGroup][$key]);
2571 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',count=' . $count);
2578 * Getter for whole generic group array
2580 * @param $keyGroup Key group to get
2581 * @return $array Whole generic array group
2583 protected final function getGenericArray ($keyGroup) {
2585 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup);
2588 if (!isset($this->genericArray[$keyGroup])) {
2590 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ' does not exist.');
2595 return $this->genericArray[$keyGroup];
2599 * Setter for generic array key
2601 * @param $keyGroup Key group to get
2602 * @param $subGroup Sub group for the key
2603 * @param $key Key to unset
2604 * @param $value Mixed value from generic array element
2607 protected final function setGenericArrayKey ($keyGroup, $subGroup, $key, $value) {
2609 //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',value[' . gettype($value) . ']=' . print_r($value, TRUE));
2612 $this->genericArray[$keyGroup][$subGroup][$key] = $value;
2616 * Getter for generic array key
2618 * @param $keyGroup Key group to get
2619 * @param $subGroup Sub group for the key
2620 * @param $key Key to unset
2621 * @return $value Mixed value from generic array element
2623 protected final function getGenericArrayKey ($keyGroup, $subGroup, $key) {
2625 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2628 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2630 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' does not exist.');
2635 return $this->genericArray[$keyGroup][$subGroup][$key];
2639 * Sets a value in given generic array key/element
2641 * @param $keyGroup Main group for the key
2642 * @param $subGroup Sub group for the key
2643 * @param $key Key to set
2644 * @param $element Element to set
2645 * @param $value Value to set
2648 protected final function setGenericArrayElement ($keyGroup, $subGroup, $key, $element, $value) {
2650 //* 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));
2653 $this->genericArray[$keyGroup][$subGroup][$key][$element] = $value;
2657 * Getter for generic array element
2659 * @param $keyGroup Key group to get
2660 * @param $subGroup Sub group for the key
2661 * @param $key Key to look for
2662 * @param $element Element to look for
2663 * @return $value Mixed value from generic array element
2665 protected final function getGenericArrayElement ($keyGroup, $subGroup, $key, $element) {
2667 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element);
2670 if (!$this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element)) {
2672 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ' does not exist.');
2677 return $this->genericArray[$keyGroup][$subGroup][$key][$element];
2681 * Checks if a given sub group is valid (array)
2683 * @param $keyGroup Key group to get
2684 * @param $subGroup Sub group for the key
2685 * @return $isValid Whether given sub group is valid
2687 protected final function isValidGenericArrayGroup ($keyGroup, $subGroup) {
2689 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup);
2692 $isValid = (($this->isGenericArrayGroupSet($keyGroup, $subGroup)) && (is_array($this->getGenericSubArray($keyGroup, $subGroup))));
2699 * Checks if a given key is valid (array)
2701 * @param $keyGroup Key group to get
2702 * @param $subGroup Sub group for the key
2703 * @param $key Key to check
2704 * @return $isValid Whether given sub group is valid
2706 protected final function isValidGenericArrayKey ($keyGroup, $subGroup, $key) {
2708 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2711 $isValid = (($this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) && (is_array($this->getGenericArrayKey($keyGroup, $subGroup, $key))));