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 - 2014 Core Developer Team
9 * @license GNU GPL 3.0 or any newer version
10 * @link http://www.shipsimu.org
12 * This program is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation, either version 3 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
27 * Length of output from hash()
29 private static $hashLength = NULL;
34 private $realClass = 'BaseFrameworkSystem';
37 * Instance of a request class
39 private $requestInstance = NULL;
42 * Instance of a response class
44 private $responseInstance = NULL;
47 * Search criteria instance
49 private $searchInstance = NULL;
52 * Update criteria instance
54 private $updateInstance = NULL;
57 * The file I/O instance for the template loader
59 private $fileIoInstance = NULL;
64 private $resolverInstance = NULL;
67 * Template engine instance
69 private $templateInstance = NULL;
72 * Database result instance
74 private $resultInstance = NULL;
77 * Instance for user class
79 private $userInstance = NULL;
82 * A controller instance
84 private $controllerInstance = NULL;
89 private $rngInstance = NULL;
92 * Instance of a crypto helper
94 private $cryptoInstance = NULL;
97 * Instance of an Iterator class
99 private $iteratorInstance = NULL;
102 * Instance of the list
104 private $listInstance = NULL;
109 private $menuInstance = NULL;
112 * Instance of the image
114 private $imageInstance = NULL;
117 * Instance of the stacker
119 private $stackInstance = NULL;
122 * A Compressor instance
124 private $compressorInstance = NULL;
127 * A Parseable instance
129 private $parserInstance = NULL;
132 * A HandleableProtocol instance
134 private $protocolInstance = NULL;
137 * A database wrapper instance
139 private $databaseInstance = NULL;
142 * A helper instance for the form
144 private $helperInstance = NULL;
147 * An instance of a Sourceable class
149 private $sourceInstance = NULL;
152 * An instance of a InputStream class
154 private $inputStreamInstance = NULL;
157 * An instance of a OutputStream class
159 private $outputStreamInstance = NULL;
162 * Networkable handler instance
164 private $handlerInstance = NULL;
167 * Visitor handler instance
169 private $visitorInstance = NULL;
174 private $dhtInstance = NULL;
177 * An instance of a database wrapper class
179 private $wrapperInstance = NULL;
182 * An instance of a file I/O pointer class (not handler)
184 private $pointerInstance = NULL;
187 * An instance of an Indexable class
189 private $indexInstance = NULL;
192 * An instance of a Block class
194 private $blockInstance = NULL;
199 private $minableInstance = NULL;
202 * A FrameworkDirectory instance
204 private $directoryInstance = NULL;
209 private $listenerInstance = NULL;
212 * Thousands separator
214 private $thousands = '.'; // German
219 private $decimals = ','; // German
224 private $socketResource = FALSE;
229 private $packageData = array();
234 private $genericArray = array();
236 /***********************
237 * Exception codes.... *
238 ***********************/
240 // @todo Try to clean these constants up
241 const EXCEPTION_IS_NULL_POINTER = 0x001;
242 const EXCEPTION_IS_NO_OBJECT = 0x002;
243 const EXCEPTION_IS_NO_ARRAY = 0x003;
244 const EXCEPTION_MISSING_METHOD = 0x004;
245 const EXCEPTION_CLASSES_NOT_MATCHING = 0x005;
246 const EXCEPTION_INDEX_OUT_OF_BOUNDS = 0x006;
247 const EXCEPTION_DIMENSION_ARRAY_INVALID = 0x007;
248 const EXCEPTION_ITEM_NOT_TRADEABLE = 0x008;
249 const EXCEPTION_ITEM_NOT_IN_PRICE_LIST = 0x009;
250 const EXCEPTION_GENDER_IS_WRONG = 0x00a;
251 const EXCEPTION_BIRTH_DATE_IS_INVALID = 0x00b;
252 const EXCEPTION_EMPTY_STRUCTURES_ARRAY = 0x00c;
253 const EXCEPTION_HAS_ALREADY_PERSONELL_LIST = 0x00d;
254 const EXCEPTION_NOT_ENOUGTH_UNEMPLOYEES = 0x00e;
255 const EXCEPTION_TOTAL_PRICE_NOT_CALCULATED = 0x00f;
256 const EXCEPTION_HARBOR_HAS_NO_SHIPYARDS = 0x010;
257 const EXCEPTION_CONTRACT_PARTNER_INVALID = 0x011;
258 const EXCEPTION_CONTRACT_PARTNER_MISMATCH = 0x012;
259 const EXCEPTION_CONTRACT_ALREADY_SIGNED = 0x013;
260 const EXCEPTION_UNEXPECTED_EMPTY_STRING = 0x014;
261 const EXCEPTION_PATH_NOT_FOUND = 0x015;
262 const EXCEPTION_INVALID_PATH_NAME = 0x016;
263 const EXCEPTION_READ_PROTECED_PATH = 0x017;
264 const EXCEPTION_WRITE_PROTECED_PATH = 0x018;
265 const EXCEPTION_DIR_POINTER_INVALID = 0x019;
266 const EXCEPTION_FILE_POINTER_INVALID = 0x01a;
267 const EXCEPTION_INVALID_RESOURCE = 0x01b;
268 const EXCEPTION_UNEXPECTED_OBJECT = 0x01c;
269 const EXCEPTION_LIMIT_ELEMENT_IS_UNSUPPORTED = 0x01d;
270 const EXCEPTION_GETTER_IS_MISSING = 0x01e;
271 const EXCEPTION_ARRAY_EXPECTED = 0x01f;
272 const EXCEPTION_ARRAY_HAS_INVALID_COUNT = 0x020;
273 const EXCEPTION_ID_IS_INVALID_FORMAT = 0x021;
274 const EXCEPTION_MD5_CHECKSUMS_MISMATCH = 0x022;
275 const EXCEPTION_UNEXPECTED_STRING_SIZE = 0x023;
276 const EXCEPTION_SIMULATOR_ID_INVALID = 0x024;
277 const EXCEPTION_MISMATCHING_COMPRESSORS = 0x025;
278 const EXCEPTION_CONTAINER_ITEM_IS_NULL = 0x026;
279 const EXCEPTION_ITEM_IS_NO_ARRAY = 0x027;
280 const EXCEPTION_CONTAINER_MAYBE_DAMAGED = 0x028;
281 const EXCEPTION_INVALID_STRING = 0x029;
282 const EXCEPTION_VARIABLE_NOT_SET = 0x02a;
283 const EXCEPTION_ATTRIBUTES_ARE_MISSING = 0x02b;
284 const EXCEPTION_ARRAY_ELEMENTS_MISSING = 0x02c;
285 const EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED = 0x02d;
286 const EXCEPTION_UNSPPORTED_OPERATION = 0x02e;
287 const EXCEPTION_FACTORY_REQUIRE_PARAMETER = 0x02f;
288 const EXCEPTION_MISSING_ELEMENT = 0x030;
289 const EXCEPTION_HEADERS_ALREADY_SENT = 0x031;
290 const EXCEPTION_DEFAULT_CONTROLLER_GONE = 0x032;
291 const EXCEPTION_CLASS_NOT_FOUND = 0x033;
292 const EXCEPTION_REQUIRED_INTERFACE_MISSING = 0x034;
293 const EXCEPTION_FATAL_ERROR = 0x035;
294 const EXCEPTION_FILE_NOT_FOUND = 0x036;
295 const EXCEPTION_ASSERTION_FAILED = 0x037;
296 const EXCEPTION_FILE_CANNOT_BE_READ = 0x038;
297 const EXCEPTION_DATABASE_UPDATED_NOT_ALLOWED = 0x039;
298 const EXCEPTION_FILTER_CHAIN_INTERCEPTED = 0x03a;
301 * Hexadecimal->Decimal translation array
303 private static $hexdec = array(
323 * Decimal->hexadecimal translation array
325 private static $dechex = array(
345 * Startup time in miliseconds
347 private static $startupTime = 0;
350 * Protected super constructor
352 * @param $className Name of the class
355 protected function __construct ($className) {
357 $this->setRealClass($className);
359 // Set configuration instance if no registry ...
360 if (!$this instanceof Register) {
361 // ... because registries doesn't need to be configured
362 $this->setConfigInstance(FrameworkConfiguration::getSelfInstance());
365 // Is the startup time set? (0 cannot be TRUE anymore)
366 if (self::$startupTime == 0) {
368 self::$startupTime = microtime(TRUE);
373 * Destructor for all classes
377 public function __destruct () {
378 // Flush any updated entries to the database
379 $this->flushPendingUpdates();
381 // Is this object already destroyed?
382 if ($this->__toString() != 'DestructedObject') {
383 // Destroy all informations about this class but keep some text about it alive
384 $this->setRealClass('DestructedObject');
385 } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
386 // Already destructed object
387 self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:] The object <span class="object_name">%s</span> is already destroyed.',
392 // Do not call this twice
393 trigger_error(__METHOD__ . ': Called twice.');
399 * The __call() method where all non-implemented methods end up
401 * @param $methodName Name of the missing method
402 * @args $args Arguments passed to the method
405 public final function __call ($methodName, $args) {
406 return self::__callStatic($methodName, $args);
410 * The __callStatic() method where all non-implemented static methods end up
412 * @param $methodName Name of the missing method
413 * @args $args Arguments passed to the method
416 public static final function __callStatic ($methodName, $args) {
417 // Init argument string
420 // Is it empty or an array?
423 $argsString = 'NULL';
424 } elseif (is_array($args)) {
425 // Some arguments are there
426 foreach ($args as $arg) {
427 // Add the value itself if not array. This prevents 'array to string conversion' message
428 if (is_array($arg)) {
429 $argsString .= 'Array';
434 // Add data about the argument
435 $argsString .= ' (' . gettype($arg);
437 if (is_string($arg)) {
438 // Add length for strings
439 $argsString .= ', ' . strlen($arg);
440 } elseif (is_array($arg)) {
441 // .. or size if array
442 $argsString .= ', ' . count($arg);
443 } elseif ($arg === TRUE) {
444 // ... is boolean 'TRUE'
445 $argsString .= ', TRUE';
446 } elseif ($arg === FALSE) {
447 // ... is boolean 'FALSE'
448 $argsString .= ', FALSE';
452 $argsString .= '), ';
456 if (substr($argsString, -2, 1) == ',') {
457 $argsString = substr($argsString, 0, -2);
460 // Invalid arguments!
461 $argsString = '!INVALID:' . gettype($args) . '!';
464 // Output stub message
465 // @TODO __CLASS__ does always return BaseFrameworkSystem but not the extending (=child) class
466 self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[unknown::%s:] Stub! Args: %s',
476 * Getter for $realClass
478 * @return $realClass The name of the real class (not BaseFrameworkSystem)
480 public function __toString () {
481 return $this->realClass;
485 * Magic function to catch setting of missing but set class fields/attributes
487 * @param $name Name of the field/attribute
488 * @param $value Value to store
491 public final function __set ($name, $value) {
492 $this->debugBackTrace(sprintf('Tried to set a missing field. name=%s, value[%s]=%s',
495 print_r($value, TRUE)
500 * Magic function to catch getting of missing fields/attributes
502 * @param $name Name of the field/attribute
505 public final function __get ($name) {
506 $this->debugBackTrace(sprintf('Tried to get a missing field. name=%s',
512 * Magic function to catch unsetting of missing fields/attributes
514 * @param $name Name of the field/attribute
517 public final function __unset ($name) {
518 $this->debugBackTrace(sprintf('Tried to unset a missing field. name=%s',
524 * Setter for the real class name
526 * @param $realClass Class name (string)
529 public final function setRealClass ($realClass) {
531 $this->realClass = (string) $realClass;
535 * Setter for database result instance
537 * @param $resultInstance An instance of a database result class
539 * @todo SearchableResult and UpdateableResult shall have a super interface to use here
541 protected final function setResultInstance (SearchableResult $resultInstance) {
542 $this->resultInstance = $resultInstance;
546 * Getter for database result instance
548 * @return $resultInstance An instance of a database result class
550 public final function getResultInstance () {
551 return $this->resultInstance;
555 * Setter for template engine instances
557 * @param $templateInstance An instance of a template engine class
560 protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
561 $this->templateInstance = $templateInstance;
565 * Getter for template engine instances
567 * @return $templateInstance An instance of a template engine class
569 protected final function getTemplateInstance () {
570 return $this->templateInstance;
574 * Setter for search instance
576 * @param $searchInstance Searchable criteria instance
579 public final function setSearchInstance (LocalSearchCriteria $searchInstance) {
580 $this->searchInstance = $searchInstance;
584 * Getter for search instance
586 * @return $searchInstance Searchable criteria instance
588 public final function getSearchInstance () {
589 return $this->searchInstance;
593 * Setter for update instance
595 * @param $updateInstance Searchable criteria instance
598 public final function setUpdateInstance (LocalUpdateCriteria $updateInstance) {
599 $this->updateInstance = $updateInstance;
603 * Getter for update instance
605 * @return $updateInstance Updateable criteria instance
607 public final function getUpdateInstance () {
608 return $this->updateInstance;
612 * Setter for resolver instance
614 * @param $resolverInstance Instance of a command resolver class
617 public final function setResolverInstance (Resolver $resolverInstance) {
618 $this->resolverInstance = $resolverInstance;
622 * Getter for resolver instance
624 * @return $resolverInstance Instance of a command resolver class
626 public final function getResolverInstance () {
627 return $this->resolverInstance;
631 * Setter for language instance
633 * @param $configInstance The configuration instance which shall
634 * be FrameworkConfiguration
637 public final function setConfigInstance (FrameworkConfiguration $configInstance) {
638 Registry::getRegistry()->addInstance('config', $configInstance);
642 * Getter for configuration instance
644 * @return $configInstance Configuration instance
646 public final function getConfigInstance () {
647 $configInstance = Registry::getRegistry()->getInstance('config');
648 return $configInstance;
652 * Setter for debug instance
654 * @param $debugInstance The instance for debug output class
657 public final function setDebugInstance (DebugMiddleware $debugInstance) {
658 Registry::getRegistry()->addInstance('debug', $debugInstance);
662 * Getter for debug instance
664 * @return $debugInstance Instance to class DebugConsoleOutput or DebugWebOutput
666 public final function getDebugInstance () {
667 // Get debug instance
668 $debugInstance = Registry::getRegistry()->getInstance('debug');
671 return $debugInstance;
675 * Setter for web output instance
677 * @param $webInstance The instance for web output class
680 public final function setWebOutputInstance (OutputStreamer $webInstance) {
681 Registry::getRegistry()->addInstance('web_output', $webInstance);
685 * Getter for web output instance
687 * @return $webOutputInstance - Instance to class WebOutput
689 public final function getWebOutputInstance () {
690 $webOutputInstance = Registry::getRegistry()->getInstance('web_output');
691 return $webOutputInstance;
695 * Setter for database instance
697 * @param $databaseInstance The instance for the database connection (forced DatabaseConnection)
700 public final function setDatabaseInstance (DatabaseConnection $databaseInstance) {
701 Registry::getRegistry()->addInstance('db_instance', $databaseInstance);
705 * Getter for database layer
707 * @return $databaseInstance The database layer instance
709 public final function getDatabaseInstance () {
711 $databaseInstance = Registry::getRegistry()->getInstance('db_instance');
714 return $databaseInstance;
718 * Setter for compressor channel
720 * @param $compressorInstance An instance of CompressorChannel
723 public final function setCompressorChannel (CompressorChannel $compressorInstance) {
724 Registry::getRegistry()->addInstance('compressor', $compressorInstance);
728 * Getter for compressor channel
730 * @return $compressorInstance The compressor channel
732 public final function getCompressorChannel () {
733 $compressorInstance = Registry::getRegistry()->getInstance('compressor');
734 return $compressorInstance;
738 * Protected getter for a manageable application helper class
740 * @return $applicationInstance An instance of a manageable application helper class
742 protected final function getApplicationInstance () {
743 $applicationInstance = Registry::getRegistry()->getInstance('application');
744 return $applicationInstance;
748 * Setter for a manageable application helper class
750 * @param $applicationInstance An instance of a manageable application helper class
753 public final function setApplicationInstance (ManageableApplication $applicationInstance) {
754 Registry::getRegistry()->addInstance('application', $applicationInstance);
758 * Setter for request instance
760 * @param $requestInstance An instance of a Requestable class
763 public final function setRequestInstance (Requestable $requestInstance) {
764 $this->requestInstance = $requestInstance;
768 * Getter for request instance
770 * @return $requestInstance An instance of a Requestable class
772 public final function getRequestInstance () {
773 return $this->requestInstance;
777 * Setter for response instance
779 * @param $responseInstance An instance of a Responseable class
782 public final function setResponseInstance (Responseable $responseInstance) {
783 $this->responseInstance = $responseInstance;
787 * Getter for response instance
789 * @return $responseInstance An instance of a Responseable class
791 public final function getResponseInstance () {
792 return $this->responseInstance;
796 * Private getter for language instance
798 * @return $langInstance An instance to the language sub-system
800 protected final function getLanguageInstance () {
801 $langInstance = Registry::getRegistry()->getInstance('language');
802 return $langInstance;
806 * Setter for language instance
808 * @param $langInstance An instance to the language sub-system
810 * @see LanguageSystem
812 public final function setLanguageInstance (ManageableLanguage $langInstance) {
813 Registry::getRegistry()->addInstance('language', $langInstance);
817 * Private getter for file IO instance
819 * @return $fileIoInstance An instance to the file I/O sub-system
821 protected final function getFileIoInstance () {
822 return $this->fileIoInstance;
826 * Setter for file I/O instance
828 * @param $fileIoInstance An instance to the file I/O sub-system
831 public final function setFileIoInstance (IoHandler $fileIoInstance) {
832 $this->fileIoInstance = $fileIoInstance;
836 * Protected setter for user instance
838 * @param $userInstance An instance of a user class
841 protected final function setUserInstance (ManageableAccount $userInstance) {
842 $this->userInstance = $userInstance;
846 * Getter for user instance
848 * @return $userInstance An instance of a user class
850 public final function getUserInstance () {
851 return $this->userInstance;
855 * Setter for controller instance (this surely breaks a bit the MVC patterm)
857 * @param $controllerInstance An instance of the controller
860 public final function setControllerInstance (Controller $controllerInstance) {
861 $this->controllerInstance = $controllerInstance;
865 * Getter for controller instance (this surely breaks a bit the MVC patterm)
867 * @return $controllerInstance An instance of the controller
869 public final function getControllerInstance () {
870 return $this->controllerInstance;
874 * Setter for RNG instance
876 * @param $rngInstance An instance of a random number generator (RNG)
879 protected final function setRngInstance (RandomNumberGenerator $rngInstance) {
880 $this->rngInstance = $rngInstance;
884 * Getter for RNG instance
886 * @return $rngInstance An instance of a random number generator (RNG)
888 public final function getRngInstance () {
889 return $this->rngInstance;
893 * Setter for Cryptable instance
895 * @param $cryptoInstance An instance of a Cryptable class
898 protected final function setCryptoInstance (Cryptable $cryptoInstance) {
899 $this->cryptoInstance = $cryptoInstance;
903 * Getter for Cryptable instance
905 * @return $cryptoInstance An instance of a Cryptable class
907 public final function getCryptoInstance () {
908 return $this->cryptoInstance;
912 * Setter for the list instance
914 * @param $listInstance A list of Listable
917 protected final function setListInstance (Listable $listInstance) {
918 $this->listInstance = $listInstance;
922 * Getter for the list instance
924 * @return $listInstance A list of Listable
926 protected final function getListInstance () {
927 return $this->listInstance;
931 * Setter for the menu instance
933 * @param $menuInstance A RenderableMenu instance
936 protected final function setMenuInstance (RenderableMenu $menuInstance) {
937 $this->menuInstance = $menuInstance;
941 * Getter for the menu instance
943 * @return $menuInstance A RenderableMenu instance
945 protected final function getMenuInstance () {
946 return $this->menuInstance;
950 * Setter for image instance
952 * @param $imageInstance An instance of an image
955 public final function setImageInstance (BaseImage $imageInstance) {
956 $this->imageInstance = $imageInstance;
960 * Getter for image instance
962 * @return $imageInstance An instance of an image
964 public final function getImageInstance () {
965 return $this->imageInstance;
969 * Setter for stacker instance
971 * @param $stackInstance An instance of an stacker
974 public final function setStackInstance (Stackable $stackInstance) {
975 $this->stackInstance = $stackInstance;
979 * Getter for stacker instance
981 * @return $stackInstance An instance of an stacker
983 public final function getStackInstance () {
984 return $this->stackInstance;
988 * Setter for compressor instance
990 * @param $compressorInstance An instance of an compressor
993 public final function setCompressorInstance (Compressor $compressorInstance) {
994 $this->compressorInstance = $compressorInstance;
998 * Getter for compressor instance
1000 * @return $compressorInstance An instance of an compressor
1002 public final function getCompressorInstance () {
1003 return $this->compressorInstance;
1007 * Setter for Parseable instance
1009 * @param $parserInstance An instance of an Parseable
1012 public final function setParserInstance (Parseable $parserInstance) {
1013 $this->parserInstance = $parserInstance;
1017 * Getter for Parseable instance
1019 * @return $parserInstance An instance of an Parseable
1021 public final function getParserInstance () {
1022 return $this->parserInstance;
1026 * Setter for HandleableProtocol instance
1028 * @param $protocolInstance An instance of an HandleableProtocol
1031 public final function setProtocolInstance (HandleableProtocol $protocolInstance = NULL) {
1032 $this->protocolInstance = $protocolInstance;
1036 * Getter for HandleableProtocol instance
1038 * @return $protocolInstance An instance of an HandleableProtocol
1040 public final function getProtocolInstance () {
1041 return $this->protocolInstance;
1045 * Setter for DatabaseWrapper instance
1047 * @param $wrapperInstance An instance of an DatabaseWrapper
1050 public final function setWrapperInstance (DatabaseWrapper $wrapperInstance) {
1051 $this->wrapperInstance = $wrapperInstance;
1055 * Getter for DatabaseWrapper instance
1057 * @return $wrapperInstance An instance of an DatabaseWrapper
1059 public final function getWrapperInstance () {
1060 return $this->wrapperInstance;
1064 * Setter for socket resource
1066 * @param $socketResource A valid socket resource
1069 public final function setSocketResource ($socketResource) {
1070 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': socketResource=' . $socketResource . ',previous[' . gettype($this->socketResource) . ']=' . $this->socketResource);
1071 $this->socketResource = $socketResource;
1075 * Getter for socket resource
1077 * @return $socketResource A valid socket resource
1079 public final function getSocketResource () {
1080 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': socketResource[' . gettype($this->socketResource) . ']=' . $this->socketResource);
1081 return $this->socketResource;
1085 * Setter for helper instance
1087 * @param $helperInstance An instance of a helper class
1090 protected final function setHelperInstance (Helper $helperInstance) {
1091 $this->helperInstance = $helperInstance;
1095 * Getter for helper instance
1097 * @return $helperInstance An instance of a helper class
1099 public final function getHelperInstance () {
1100 return $this->helperInstance;
1104 * Setter for a Sourceable instance
1106 * @param $sourceInstance The Sourceable instance
1109 protected final function setSourceInstance (Sourceable $sourceInstance) {
1110 $this->sourceInstance = $sourceInstance;
1114 * Getter for a Sourceable instance
1116 * @return $sourceInstance The Sourceable instance
1118 protected final function getSourceInstance () {
1119 return $this->sourceInstance;
1123 * Getter for a InputStream instance
1125 * @param $inputStreamInstance The InputStream instance
1127 protected final function getInputStreamInstance () {
1128 return $this->inputStreamInstance;
1132 * Setter for a InputStream instance
1134 * @param $inputStreamInstance The InputStream instance
1137 protected final function setInputStreamInstance (InputStream $inputStreamInstance) {
1138 $this->inputStreamInstance = $inputStreamInstance;
1142 * Getter for a OutputStream instance
1144 * @param $outputStreamInstance The OutputStream instance
1146 protected final function getOutputStreamInstance () {
1147 return $this->outputStreamInstance;
1151 * Setter for a OutputStream instance
1153 * @param $outputStreamInstance The OutputStream instance
1156 protected final function setOutputStreamInstance (OutputStream $outputStreamInstance) {
1157 $this->outputStreamInstance = $outputStreamInstance;
1161 * Setter for handler instance
1163 * @param $handlerInstance An instance of a Handleable class
1166 protected final function setHandlerInstance (Handleable $handlerInstance) {
1167 $this->handlerInstance = $handlerInstance;
1171 * Getter for handler instance
1173 * @return $handlerInstance A Networkable instance
1175 protected final function getHandlerInstance () {
1176 return $this->handlerInstance;
1180 * Setter for visitor instance
1182 * @param $visitorInstance A Visitor instance
1185 protected final function setVisitorInstance (Visitor $visitorInstance) {
1186 $this->visitorInstance = $visitorInstance;
1190 * Getter for visitor instance
1192 * @return $visitorInstance A Visitor instance
1194 protected final function getVisitorInstance () {
1195 return $this->visitorInstance;
1199 * Setter for DHT instance
1201 * @param $dhtInstance A Distributable instance
1204 protected final function setDhtInstance (Distributable $dhtInstance) {
1205 $this->dhtInstance = $dhtInstance;
1209 * Getter for DHT instance
1211 * @return $dhtInstance A Distributable instance
1213 protected final function getDhtInstance () {
1214 return $this->dhtInstance;
1218 * Setter for raw package Data
1220 * @param $packageData Raw package Data
1223 public final function setPackageData (array $packageData) {
1224 $this->packageData = $packageData;
1228 * Getter for raw package Data
1230 * @return $packageData Raw package Data
1232 public function getPackageData () {
1233 return $this->packageData;
1238 * Setter for Iterator instance
1240 * @param $iteratorInstance An instance of an Iterator
1243 protected final function setIteratorInstance (Iterator $iteratorInstance) {
1244 $this->iteratorInstance = $iteratorInstance;
1248 * Getter for Iterator instance
1250 * @return $iteratorInstance An instance of an Iterator
1252 public final function getIteratorInstance () {
1253 return $this->iteratorInstance;
1257 * Setter for FilePointer instance
1259 * @param $pointerInstance An instance of an FilePointer class
1262 protected final function setPointerInstance (FilePointer $pointerInstance) {
1263 $this->pointerInstance = $pointerInstance;
1267 * Getter for FilePointer instance
1269 * @return $pointerInstance An instance of an FilePointer class
1271 public final function getPointerInstance () {
1272 return $this->pointerInstance;
1276 * Setter for Indexable instance
1278 * @param $indexInstance An instance of an Indexable class
1281 protected final function setIndexInstance (Indexable $indexInstance) {
1282 $this->indexInstance = $indexInstance;
1286 * Getter for Indexable instance
1288 * @return $indexInstance An instance of an Indexable class
1290 public final function getIndexInstance () {
1291 return $this->indexInstance;
1295 * Setter for Block instance
1297 * @param $blockInstance An instance of an Block class
1300 protected final function setBlockInstance (Block $blockInstance) {
1301 $this->blockInstance = $blockInstance;
1305 * Getter for Block instance
1307 * @return $blockInstance An instance of an Block class
1309 public final function getBlockInstance () {
1310 return $this->blockInstance;
1314 * Setter for Minable instance
1316 * @param $minableInstance A Minable instance
1319 protected final function setMinableInstance (Minable $minableInstance) {
1320 $this->minableInstance = $minableInstance;
1324 * Getter for minable instance
1326 * @return $minableInstance A Minable instance
1328 protected final function getMinableInstance () {
1329 return $this->minableInstance;
1333 * Setter for FrameworkDirectory instance
1335 * @param $directoryInstance A FrameworkDirectoryPointer instance
1338 protected final function setDirectoryInstance (FrameworkDirectory $directoryInstance) {
1339 $this->directoryInstance = $directoryInstance;
1343 * Getter for FrameworkDirectory instance
1345 * @return $directoryInstance A FrameworkDirectory instance
1347 protected final function getDirectoryInstance () {
1348 return $this->directoryInstance;
1352 * Setter for listener instance
1354 * @param $listenerInstance A Listenable instance
1357 protected final function setListenerInstance (Listenable $listenerInstance) {
1358 $this->listenerInstance = $listenerInstance;
1362 * Getter for listener instance
1364 * @return $listenerInstance A Listenable instance
1366 protected final function getListenerInstance () {
1367 return $this->listenerInstance;
1371 * Checks whether an object equals this object. You should overwrite this
1372 * method to implement own equality checks
1374 * @param $objectInstance An instance of a FrameworkInterface object
1375 * @return $equals Whether both objects equals
1377 public function equals (FrameworkInterface $objectInstance) {
1380 $this->__toString() == $objectInstance->__toString()
1382 $this->hashCode() == $objectInstance->hashCode()
1385 // Return the result
1390 * Generates a generic hash code of this class. You should really overwrite
1391 * this method with your own hash code generator code. But keep KISS in mind.
1393 * @return $hashCode A generic hash code respresenting this whole class
1395 public function hashCode () {
1397 return crc32($this->__toString());
1401 * Formats computer generated price values into human-understandable formats
1402 * with thousand and decimal separators.
1404 * @param $value The in computer format value for a price
1405 * @param $currency The currency symbol (use HTML-valid characters!)
1406 * @param $decNum Number of decimals after commata
1407 * @return $price The for the current language formated price string
1408 * @throws MissingDecimalsThousandsSeparatorException If decimals or
1409 * thousands separator
1412 public function formatCurrency ($value, $currency = '€', $decNum = 2) {
1413 // Are all required attriutes set?
1414 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
1415 // Throw an exception
1416 throw new MissingDecimalsThousandsSeparatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
1420 $value = (float) $value;
1422 // Reformat the US number
1423 $price = number_format($value, $decNum, $this->decimals, $this->thousands) . $currency;
1425 // Return as string...
1430 * Appends a trailing slash to a string
1432 * @param $str A string (maybe) without trailing slash
1433 * @return $str A string with an auto-appended trailing slash
1435 public final function addMissingTrailingSlash ($str) {
1436 // Is there a trailing slash?
1437 if (substr($str, -1, 1) != '/') {
1441 // Return string with trailing slash
1446 * Prepare the template engine (WebTemplateEngine by default) for a given
1447 * application helper instance (ApplicationHelper by default).
1449 * @param $applicationInstance An application helper instance or
1450 * null if we shall use the default
1451 * @return $templateInstance The template engine instance
1452 * @throws NullPointerException If the discovered application
1453 * instance is still null
1455 protected function prepareTemplateInstance (ManageableApplication $applicationInstance = NULL) {
1456 // Is the application instance set?
1457 if (is_null($applicationInstance)) {
1458 // Get the current instance
1459 $applicationInstance = $this->getApplicationInstance();
1462 if (is_null($applicationInstance)) {
1463 // Thrown an exception
1464 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1468 // Initialize the template engine
1469 $templateInstance = ObjectFactory::createObjectByConfiguredName('web_template_class');
1471 // Return the prepared instance
1472 return $templateInstance;
1476 * Debugs this instance by putting out it's full content
1478 * @param $message Optional message to show in debug output
1481 public final function debugInstance ($message = '') {
1482 // Restore the error handler to avoid trouble with missing array elements or undeclared variables
1483 restore_error_handler();
1488 // Is a message set?
1489 if (!empty($message)) {
1490 // Construct message
1491 $content = sprintf('<div class="debug_message">Message: %s</div>' . PHP_EOL, $message);
1494 // Generate the output
1495 $content .= sprintf('<pre>%s</pre>',
1498 print_r($this, TRUE)
1504 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>',
1505 $this->__toString(),
1507 ClassLoader::getSelfInstance()->getPrintableIncludeList()
1512 * Replaces control characters with printable output
1514 * @param $str String with control characters
1515 * @return $str Replaced string
1517 protected function replaceControlCharacters ($str) {
1520 chr(13), '[r]', str_replace(
1521 chr(10), '[n]', str_replace(
1531 * Output a partial stub message for the caller method
1533 * @param $message An optional message to display
1536 protected function partialStub ($message = '') {
1537 // Get the backtrace
1538 $backtrace = debug_backtrace();
1540 // Generate the class::method string
1541 $methodName = 'UnknownClass->unknownMethod';
1542 if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
1543 $methodName = $backtrace[1]['class'] . '->' . $backtrace[1]['function'];
1546 // Construct the full message
1547 $stubMessage = sprintf('[%s:] Partial stub!',
1551 // Is the extra message given?
1552 if (!empty($message)) {
1553 // Then add it as well
1554 $stubMessage .= ' Message: ' . $message;
1557 // Debug instance is there?
1558 if (!is_null($this->getDebugInstance())) {
1559 // Output stub message
1560 self::createDebugInstance(__CLASS__)->debugOutput($stubMessage);
1563 trigger_error($stubMessage);
1569 * Outputs a debug backtrace and stops further script execution
1571 * @param $message An optional message to output
1572 * @param $doExit Whether exit the program (TRUE is default)
1575 public function debugBackTrace ($message = '', $doExit = TRUE) {
1576 // Sorry, there is no other way getting this nice backtrace
1577 if (!empty($message)) {
1579 printf('Message: %s<br />' . chr(10), $message);
1583 debug_print_backtrace();
1587 if ($doExit === TRUE) {
1593 * Creates an instance of a debugger instance
1595 * @param $className Name of the class (currently unsupported)
1596 * @return $debugInstance An instance of a debugger class
1598 public final static function createDebugInstance ($className) {
1599 // Is the instance set?
1600 if (!Registry::getRegistry()->instanceExists('debug')) {
1601 // Init debug instance
1602 $debugInstance = NULL;
1606 // Get a debugger instance
1607 $debugInstance = DebugMiddleware::createDebugMiddleware(FrameworkConfiguration::getSelfInstance()->getConfigEntry('debug_class'));
1608 } catch (NullPointerException $e) {
1609 // Didn't work, no instance there
1610 exit('Cannot create debugInstance! Exception=' . $e->__toString() . ', message=' . $e->getMessage());
1613 // Empty string should be ignored and used for testing the middleware
1614 DebugMiddleware::getSelfInstance()->output('');
1616 // Set it in its own class. This will set it in the registry
1617 $debugInstance->setDebugInstance($debugInstance);
1619 // Get instance from registry
1620 $debugInstance = Registry::getRegistry()->getDebugInstance();
1624 return $debugInstance;
1628 * Simple output of a message with line-break
1630 * @param $message Message to output
1633 public function outputLine ($message) {
1635 print($message . PHP_EOL);
1639 * Outputs a debug message whether to debug instance (should be set!) or
1640 * dies with or ptints the message. Do NEVER EVER rewrite the exit() call to
1641 * ApplicationEntryPoint::app_exit(), this would cause an endless loop.
1643 * @param $message Message we shall send out...
1644 * @param $doPrint Whether print or die here (default: print)
1645 * @paran $stripTags Whether to strip tags (default: FALSE)
1648 public function debugOutput ($message, $doPrint = TRUE, $stripTags = FALSE) {
1649 // Set debug instance to NULL
1650 $debugInstance = NULL;
1654 // Get debug instance
1655 $debugInstance = $this->getDebugInstance();
1656 } catch (NullPointerException $e) {
1657 // The debug instance is not set (yet)
1660 // Is the debug instance there?
1661 if (is_object($debugInstance)) {
1662 // Use debug output handler
1663 $debugInstance->output($message, $stripTags);
1665 if ($doPrint === FALSE) {
1666 // Die here if not printed
1670 // Are debug times enabled?
1671 if ($this->getConfigInstance()->getConfigEntry('debug_output_timings') == 'Y') {
1673 $message = $this->getPrintableExecutionTime() . $message;
1677 if ($doPrint === TRUE) {
1679 $this->outputLine($message);
1688 * Converts e.g. a command from URL to a valid class by keeping out bad characters
1690 * @param $str The string, what ever it is needs to be converted
1691 * @return $className Generated class name
1693 public function convertToClassName ($str) {
1697 // Convert all dashes in underscores
1698 $str = $this->convertDashesToUnderscores($str);
1700 // Now use that underscores to get classname parts for hungarian style
1701 foreach (explode('_', $str) as $strPart) {
1702 // Make the class name part lower case and first upper case
1703 $className .= ucfirst(strtolower($strPart));
1706 // Return class name
1711 * Converts dashes to underscores, e.g. useable for configuration entries
1713 * @param $str The string with maybe dashes inside
1714 * @return $str The converted string with no dashed, but underscores
1716 public final function convertDashesToUnderscores ($str) {
1718 $str = str_replace('-', '_', $str);
1720 // Return converted string
1725 * Marks up the code by adding e.g. line numbers
1727 * @param $phpCode Unmarked PHP code
1728 * @return $markedCode Marked PHP code
1730 public function markupCode ($phpCode) {
1735 $errorArray = error_get_last();
1737 // Init the code with error message
1738 if (is_array($errorArray)) {
1740 $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>',
1741 basename($errorArray['file']),
1742 $errorArray['line'],
1743 $errorArray['message'],
1748 // Add line number to the code
1749 foreach (explode(chr(10), $phpCode) as $lineNo => $code) {
1751 $markedCode .= sprintf('<span id="code_line">%s</span>: %s' . chr(10),
1753 htmlentities($code, ENT_QUOTES)
1762 * Filter a given GMT timestamp (non Uni* stamp!) to make it look more
1763 * beatiful for web-based front-ends. If null is given a message id
1764 * null_timestamp will be resolved and returned.
1766 * @param $timestamp Timestamp to prepare (filter) for display
1767 * @return $readable A readable timestamp
1769 public function doFilterFormatTimestamp ($timestamp) {
1770 // Default value to return
1773 // Is the timestamp null?
1774 if (is_null($timestamp)) {
1775 // Get a message string
1776 $readable = $this->getLanguageInstance()->getMessage('null_timestamp');
1778 switch ($this->getLanguageInstance()->getLanguageCode()) {
1779 case 'de': // German format is a bit different to default
1780 // Split the GMT stamp up
1781 $dateTime = explode(' ', $timestamp );
1782 $dateArray = explode('-', $dateTime[0]);
1783 $timeArray = explode(':', $dateTime[1]);
1785 // Construct the timestamp
1786 $readable = sprintf($this->getConfigInstance()->getConfigEntry('german_date_time'),
1796 default: // Default is pass-through
1797 $readable = $timestamp;
1807 * Filter a given number into a localized number
1809 * @param $value The raw value from e.g. database
1810 * @return $localized Localized value
1812 public function doFilterFormatNumber ($value) {
1813 // Generate it from config and localize dependencies
1814 switch ($this->getLanguageInstance()->getLanguageCode()) {
1815 case 'de': // German format is a bit different to default
1816 $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), ',', '.');
1819 default: // US, etc.
1820 $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), '.', ',');
1829 * "Getter" for databse entry
1831 * @return $entry An array with database entries
1832 * @throws NullPointerException If the database result is not found
1833 * @throws InvalidDatabaseResultException If the database result is invalid
1835 protected final function getDatabaseEntry () {
1836 // Is there an instance?
1837 if (is_null($this->getResultInstance())) {
1838 // Throw an exception here
1839 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1843 $this->getResultInstance()->rewind();
1845 // Do we have an entry?
1846 if ($this->getResultInstance()->valid() === FALSE) {
1847 throw new InvalidDatabaseResultException(array($this, $this->getResultInstance()), DatabaseResult::EXCEPTION_INVALID_DATABASE_RESULT);
1851 $this->getResultInstance()->next();
1854 $entry = $this->getResultInstance()->current();
1861 * Getter for field name
1863 * @param $fieldName Field name which we shall get
1864 * @return $fieldValue Field value from the user
1865 * @throws NullPointerException If the result instance is null
1867 public final function getField ($fieldName) {
1868 // Default field value
1871 // Get result instance
1872 $resultInstance = $this->getResultInstance();
1874 // Is this instance null?
1875 if (is_null($resultInstance)) {
1876 // Then the user instance is no longer valid (expired cookies?)
1877 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1880 // Get current array
1881 $fieldArray = $resultInstance->current();
1882 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($fieldName.':<pre>'.print_r($fieldArray, TRUE).'</pre>');
1884 // Convert dashes to underscore
1885 $fieldName = $this->convertDashesToUnderscores($fieldName);
1887 // Does the field exist?
1888 if (isset($fieldArray[$fieldName])) {
1890 $fieldValue = $fieldArray[$fieldName];
1892 // Missing field entry, may require debugging
1893 self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']:fieldName=' . $fieldName . ' not found!');
1901 * Flushs all pending updates to the database layer
1905 public function flushPendingUpdates () {
1906 // Get result instance
1907 $resultInstance = $this->getResultInstance();
1909 // Do we have data to update?
1910 if ((is_object($resultInstance)) && ($resultInstance->ifDataNeedsFlush())) {
1911 // Get wrapper class name config entry
1912 $configEntry = $resultInstance->getUpdateInstance()->getWrapperConfigEntry();
1914 // Create object instance
1915 $wrapperInstance = ObjectFactory::createObjectByConfiguredName($configEntry);
1917 // Yes, then send the whole result to the database layer
1918 $wrapperInstance->doUpdateByResult($this->getResultInstance());
1923 * Outputs a deprecation warning to the developer.
1925 * @param $message The message we shall output to the developer
1927 * @todo Write a logging mechanism for productive mode
1929 public function deprecationWarning ($message) {
1930 // Is developer mode active?
1931 if (defined('DEVELOPER')) {
1932 // Debug instance is there?
1933 if (!is_null($this->getDebugInstance())) {
1934 // Output stub message
1935 self::createDebugInstance(__CLASS__)->debugOutput($message);
1938 trigger_error($message . "<br />\n");
1942 // @TODO Finish this part!
1943 $this->partialStub('Developer mode inactive. Message:' . $message);
1948 * Checks whether the given PHP extension is loaded
1950 * @param $phpExtension The PHP extension we shall check
1951 * @return $isLoaded Whether the PHP extension is loaded
1953 public final function isPhpExtensionLoaded ($phpExtension) {
1955 $isLoaded = in_array($phpExtension, get_loaded_extensions());
1962 * "Getter" as a time() replacement but with milliseconds. You should use this
1963 * method instead of the encapsulated getimeofday() function.
1965 * @return $milliTime Timestamp with milliseconds
1967 public function getMilliTime () {
1968 // Get the time of day as float
1969 $milliTime = gettimeofday(TRUE);
1976 * Idles (sleeps) for given milliseconds
1978 * @return $hasSlept Whether it goes fine
1980 public function idle ($milliSeconds) {
1981 // Sleep is fine by default
1984 // Idle so long with found function
1985 if (function_exists('time_sleep_until')) {
1986 // Get current time and add idle time
1987 $sleepUntil = $this->getMilliTime() + abs($milliSeconds) / 1000;
1989 // New PHP 5.1.0 function found, ignore errors
1990 $hasSlept = @time_sleep_until($sleepUntil);
1993 * My Sun station doesn't have that function even with latest PHP
1996 usleep($milliSeconds * 1000);
2003 * Converts a hexadecimal string, even with negative sign as first string to
2004 * a decimal number using BC functions.
2006 * This work is based on comment #86673 on php.net documentation page at:
2007 * <http://de.php.net/manual/en/function.dechex.php#86673>
2009 * @param $hex Hexadecimal string
2010 * @return $dec Decimal number
2012 protected function hex2dec ($hex) {
2013 // Convert to all lower-case
2014 $hex = strtolower($hex);
2016 // Detect sign (negative/positive numbers)
2018 if (substr($hex, 0, 1) == '-') {
2020 $hex = substr($hex, 1);
2023 // Decode the hexadecimal string into a decimal number
2025 for ($i = strlen($hex) - 1, $e = 1; $i >= 0; $i--, $e = bcmul($e, 16)) {
2026 $factor = self::$hexdec[substr($hex, $i, 1)];
2027 $dec = bcadd($dec, bcmul($factor, $e));
2030 // Return the decimal number
2031 return $sign . $dec;
2035 * Converts even very large decimal numbers, also signed, to a hexadecimal
2038 * This work is based on comment #97756 on php.net documentation page at:
2039 * <http://de.php.net/manual/en/function.hexdec.php#97756>
2041 * @param $dec Decimal number, even with negative sign
2042 * @param $maxLength Optional maximum length of the string
2043 * @return $hex Hexadecimal string
2045 protected function dec2hex ($dec, $maxLength = 0) {
2046 // maxLength can be zero or devideable by 2
2047 assert(($maxLength == 0) || (($maxLength % 2) == 0));
2049 // Detect sign (negative/positive numbers)
2056 // Encode the decimal number into a hexadecimal string
2059 $hex = self::$dechex[($dec % (2 ^ 4))] . $hex;
2061 } while ($dec >= 1);
2064 * Leading zeros are required for hex-decimal "numbers". In some
2065 * situations more leading zeros are wanted, so check for both
2068 if ($maxLength > 0) {
2069 // Prepend more zeros
2070 $hex = str_pad($hex, $maxLength, '0', STR_PAD_LEFT);
2071 } elseif ((strlen($hex) % 2) != 0) {
2072 // Only make string's length dividable by 2
2076 // Return the hexadecimal string
2077 return $sign . $hex;
2081 * Converts a ASCII string (0 to 255) into a decimal number.
2083 * @param $asc The ASCII string to be converted
2084 * @return $dec Decimal number
2086 protected function asc2dec ($asc) {
2087 // Convert it into a hexadecimal number
2088 $hex = bin2hex($asc);
2090 // And back into a decimal number
2091 $dec = $this->hex2dec($hex);
2098 * Converts a decimal number into an ASCII string.
2100 * @param $dec Decimal number
2101 * @return $asc An ASCII string
2103 protected function dec2asc ($dec) {
2104 // First convert the number into a hexadecimal string
2105 $hex = $this->dec2hex($dec);
2107 // Then convert it into the ASCII string
2108 $asc = $this->hex2asc($hex);
2115 * Converts a hexadecimal number into an ASCII string. Negative numbers
2118 * @param $hex Hexadecimal string
2119 * @return $asc An ASCII string
2121 protected function hex2asc ($hex) {
2122 // Check for length, it must be devideable by 2
2123 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('hex='.$hex);
2124 assert((strlen($hex) % 2) == 0);
2128 for ($idx = 0; $idx < strlen($hex); $idx+=2) {
2129 // Get the decimal number of the chunk
2130 $part = hexdec(substr($hex, $idx, 2));
2132 // Add it to the final string
2136 // Return the final string
2141 * Checks whether the given encoded data was encoded with Base64
2143 * @param $encodedData Encoded data we shall check
2144 * @return $isBase64 Whether the encoded data is Base64
2146 protected function isBase64Encoded ($encodedData) {
2148 $isBase64 = (@base64_decode($encodedData, TRUE) !== FALSE);
2155 * "Getter" to get response/request type from analysis of the system.
2157 * @return $responseType Analyzed response type
2159 protected function getResponseTypeFromSystem () {
2160 // Default is console
2161 $responseType = 'console';
2163 // Is 'HTTP_HOST' set?
2164 if (isset($_SERVER['HTTP_HOST'])) {
2165 // Then it is a HTTP response/request
2166 $responseType = 'http';
2170 return $responseType;
2174 * Gets a cache key from Criteria instance
2176 * @param $criteriaInstance An instance of a Criteria class
2177 * @param $onlyKeys Only use these keys for a cache key
2178 * @return $cacheKey A cache key suitable for lookup/storage purposes
2180 protected function getCacheKeyByCriteria (Criteria $criteriaInstance, array $onlyKeys = array()) {
2182 $cacheKey = sprintf('%s@%s',
2183 $this->__toString(),
2184 $criteriaInstance->getCacheKey($onlyKeys)
2188 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . ': cacheKey=' . $cacheKey);
2193 * Getter for startup time in miliseconds
2195 * @return $startupTime Startup time in miliseconds
2197 protected function getStartupTime () {
2198 return self::$startupTime;
2202 * "Getter" for a printable currently execution time in nice braces
2204 * @return $executionTime Current execution time in nice braces
2206 protected function getPrintableExecutionTime () {
2207 // Caculate the execution time
2208 $executionTime = microtime(TRUE) - $this->getStartupTime();
2210 // Pack it in nice braces
2211 $executionTime = sprintf('[ %01.5f ] ', $executionTime);
2214 return $executionTime;
2218 * Hashes a given string with a simple but stronger hash function (no salt)
2219 * and hex-encode it.
2221 * @param $str The string to be hashed
2222 * @return $hash The hash from string $str
2224 public static final function hash ($str) {
2225 // Hash given string with (better secure) hasher
2226 $hash = bin2hex(mhash(MHASH_SHA256, $str));
2233 * "Getter" for length of hash() output. This will be "cached" to speed up
2236 * @return $length Length of hash() output
2238 public static final function getHashLength () {
2240 if (is_null(self::$hashLength)) {
2241 // No, then hash a string and save its length.
2242 self::$hashLength = strlen(self::hash('abc123'));
2246 return self::$hashLength;
2250 * Checks whether the given number is really a number (only chars 0-9).
2252 * @param $num A string consisting only chars between 0 and 9
2253 * @param $castValue Whether to cast the value to double. Do only use this to secure numbers from Requestable classes.
2254 * @param $assertMismatch Whether to assert mismatches
2255 * @return $ret The (hopefully) secured numbered value
2257 public function bigintval ($num, $castValue = TRUE, $assertMismatch = FALSE) {
2258 // Filter all numbers out
2259 $ret = preg_replace('/[^0123456789]/', '', $num);
2262 if ($castValue === TRUE) {
2263 // Cast to biggest numeric type
2264 $ret = (double) $ret;
2267 // Assert only if requested
2268 if ($assertMismatch === TRUE) {
2269 // Has the whole value changed?
2270 assert(('' . $ret . '' != '' . $num . '') && (!is_null($num)));
2278 * Checks whether the given hexadecimal number is really a hex-number (only chars 0-9,a-f).
2280 * @param $num A string consisting only chars between 0 and 9
2281 * @param $assertMismatch Whether to assert mismatches
2282 * @return $ret The (hopefully) secured hext-numbered value
2284 public function hexval ($num, $assertMismatch = FALSE) {
2285 // Filter all numbers out
2286 $ret = preg_replace('/[^0123456789abcdefABCDEF]/', '', $num);
2288 // Assert only if requested
2289 if ($assertMismatch === TRUE) {
2290 // Has the whole value changed?
2291 assert(('' . $ret . '' != '' . $num . '') && (!is_null($num)));
2299 * Checks whether start/end marker are set
2301 * @param $data Data to be checked
2302 * @return $isset Whether start/end marker are set
2304 public final function ifStartEndMarkersSet ($data) {
2306 $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));
2308 // ... and return it
2313 * Determines if an element is set in the generic array
2315 * @param $keyGroup Main group for the key
2316 * @param $subGroup Sub group for the key
2317 * @param $key Key to check
2318 * @param $element Element to check
2319 * @return $isset Whether the given key is set
2321 protected final function isGenericArrayElementSet ($keyGroup, $subGroup, $key, $element) {
2323 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element);
2326 $isset = isset($this->genericArray[$keyGroup][$subGroup][$key][$element]);
2332 * Determines if a key is set in the generic array
2334 * @param $keyGroup Main group for the key
2335 * @param $subGroup Sub group for the key
2336 * @param $key Key to check
2337 * @return $isset Whether the given key is set
2339 protected final function isGenericArrayKeySet ($keyGroup, $subGroup, $key) {
2341 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2344 $isset = isset($this->genericArray[$keyGroup][$subGroup][$key]);
2352 * Determines if a group is set in the generic array
2354 * @param $keyGroup Main group
2355 * @param $subGroup Sub group
2356 * @return $isset Whether the given group is set
2358 protected final function isGenericArrayGroupSet ($keyGroup, $subGroup) {
2360 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup);
2363 $isset = isset($this->genericArray[$keyGroup][$subGroup]);
2370 * Getter for sub key group
2372 * @param $keyGroup Main key group
2373 * @param $subGroup Sub key group
2374 * @return $array An array with all array elements
2376 protected final function getGenericSubArray ($keyGroup, $subGroup) {
2378 if (!$this->isGenericArrayGroupSet($keyGroup, $subGroup)) {
2379 // No, then abort here
2380 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.');
2385 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',value=' . print_r($this->genericArray[$keyGroup][$subGroup], TRUE));
2388 return $this->genericArray[$keyGroup][$subGroup];
2392 * Unsets a given key in generic array
2394 * @param $keyGroup Main group for the key
2395 * @param $subGroup Sub group for the key
2396 * @param $key Key to unset
2399 protected final function unsetGenericArrayKey ($keyGroup, $subGroup, $key) {
2401 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2404 unset($this->genericArray[$keyGroup][$subGroup][$key]);
2408 * Unsets a given element in generic array
2410 * @param $keyGroup Main group for the key
2411 * @param $subGroup Sub group for the key
2412 * @param $key Key to unset
2413 * @param $element Element to unset
2416 protected final function unsetGenericArrayElement ($keyGroup, $subGroup, $key, $element) {
2418 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element);
2421 unset($this->genericArray[$keyGroup][$subGroup][$key][$element]);
2425 * Append a string to a given generic array key
2427 * @param $keyGroup Main group for the key
2428 * @param $subGroup Sub group for the key
2429 * @param $key Key to unset
2430 * @param $value Value to add/append
2433 protected final function appendStringToGenericArrayKey ($keyGroup, $subGroup, $key, $value, $appendGlue = '') {
2435 //* 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);
2437 // Is it already there?
2438 if ($this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2440 $this->genericArray[$keyGroup][$subGroup][$key] .= $appendGlue . (string) $value;
2443 $this->genericArray[$keyGroup][$subGroup][$key] = (string) $value;
2448 * Append a string to a given generic array element
2450 * @param $keyGroup Main group for the key
2451 * @param $subGroup Sub group for the key
2452 * @param $key Key to unset
2453 * @param $element Element to check
2454 * @param $value Value to add/append
2457 protected final function appendStringToGenericArrayElement ($keyGroup, $subGroup, $key, $element, $value, $appendGlue = '') {
2459 //* 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);
2461 // Is it already there?
2462 if ($this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element)) {
2464 $this->genericArray[$keyGroup][$subGroup][$key][$element] .= $appendGlue . (string) $value;
2467 $this->genericArray[$keyGroup][$subGroup][$key][$element] = (string) $value;
2472 * Initializes given generic array group
2474 * @param $keyGroup Main group for the key
2475 * @param $subGroup Sub group for the key
2476 * @param $key Key to use
2477 * @param $forceInit Optionally force initialization
2480 protected final function initGenericArrayGroup ($keyGroup, $subGroup, $forceInit = FALSE) {
2482 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',forceInit=' . intval($forceInit));
2484 // Is it already set?
2485 if (($forceInit === FALSE) && ($this->isGenericArrayGroupSet($keyGroup, $subGroup))) {
2486 // Already initialized
2487 trigger_error(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' already initialized.');
2492 $this->genericArray[$keyGroup][$subGroup] = array();
2496 * Initializes given generic array key
2498 * @param $keyGroup Main group for the key
2499 * @param $subGroup Sub group for the key
2500 * @param $key Key to use
2501 * @param $forceInit Optionally force initialization
2504 protected final function initGenericArrayKey ($keyGroup, $subGroup, $key, $forceInit = FALSE) {
2506 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',forceInit=' . intval($forceInit));
2508 // Is it already set?
2509 if (($forceInit === FALSE) && ($this->isGenericArrayKeySet($keyGroup, $subGroup, $key))) {
2510 // Already initialized
2511 trigger_error(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' already initialized.');
2516 $this->genericArray[$keyGroup][$subGroup][$key] = array();
2520 * Initializes given generic array element
2522 * @param $keyGroup Main group for the key
2523 * @param $subGroup Sub group for the key
2524 * @param $key Key to use
2525 * @param $element Element to use
2526 * @param $forceInit Optionally force initialization
2529 protected final function initGenericArrayElement ($keyGroup, $subGroup, $key, $element, $forceInit = FALSE) {
2531 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',forceInit=' . intval($forceInit));
2533 // Is it already set?
2534 if (($forceInit === FALSE) && ($this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element))) {
2535 // Already initialized
2536 trigger_error(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ' already initialized.');
2541 $this->genericArray[$keyGroup][$subGroup][$key][$element] = array();
2545 * Pushes an element to a generic key
2547 * @param $keyGroup Main group for the key
2548 * @param $subGroup Sub group for the key
2549 * @param $key Key to use
2550 * @param $value Value to add/append
2551 * @return $count Number of array elements
2553 protected final function pushValueToGenericArrayKey ($keyGroup, $subGroup, $key, $value) {
2555 //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',value[' . gettype($value) . ']=' . print_r($value, TRUE));
2558 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2560 $this->initGenericArrayKey($keyGroup, $subGroup, $key);
2564 $count = array_push($this->genericArray[$keyGroup][$subGroup][$key], $value);
2567 //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE));
2568 //* DEBUG: */ print(__METHOD__ . ': count=' . $count . PHP_EOL);
2573 * Pushes an element to a generic array element
2575 * @param $keyGroup Main group for the key
2576 * @param $subGroup Sub group for the key
2577 * @param $key Key to use
2578 * @param $element Element to check
2579 * @param $value Value to add/append
2580 * @return $count Number of array elements
2582 protected final function pushValueToGenericArrayElement ($keyGroup, $subGroup, $key, $element, $value) {
2584 //* 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));
2587 if (!$this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element)) {
2589 $this->initGenericArrayElement($keyGroup, $subGroup, $key, $element);
2593 $count = array_push($this->genericArray[$keyGroup][$subGroup][$key][$element], $value);
2596 //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE));
2597 //* DEBUG: */ print(__METHOD__ . ': count=' . $count . PHP_EOL);
2602 * Pops an element from a generic group
2604 * @param $keyGroup Main group for the key
2605 * @param $subGroup Sub group for the key
2606 * @param $key Key to unset
2607 * @return $value Last "popped" value
2609 protected final function popGenericArrayElement ($keyGroup, $subGroup, $key) {
2611 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2614 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2616 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' not found.');
2621 $value = array_pop($this->genericArray[$keyGroup][$subGroup][$key]);
2624 //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE));
2625 //* DEBUG: */ print(__METHOD__ . ': value[' . gettype($value) . ']=' . print_r($value, TRUE) . PHP_EOL);
2630 * Shifts an element from a generic group
2632 * @param $keyGroup Main group for the key
2633 * @param $subGroup Sub group for the key
2634 * @param $key Key to unset
2635 * @return $value Last "popped" value
2637 protected final function shiftGenericArrayElement ($keyGroup, $subGroup, $key) {
2639 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2642 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2644 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' not found.');
2649 $value = array_shift($this->genericArray[$keyGroup][$subGroup][$key]);
2652 //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE));
2653 //* DEBUG: */ print(__METHOD__ . ': value[' . gettype($value) . ']=' . print_r($value, TRUE) . PHP_EOL);
2658 * Count generic array group
2660 * @param $keyGroup Main group for the key
2661 * @return $count Count of given group
2663 protected final function countGenericArray ($keyGroup) {
2665 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup);
2668 if (!isset($this->genericArray[$keyGroup])) {
2670 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ' not found.');
2675 $count = count($this->genericArray[$keyGroup]);
2678 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',count=' . $count);
2685 * Count generic array sub group
2687 * @param $keyGroup Main group for the key
2688 * @param $subGroup Sub group for the key
2689 * @return $count Count of given group
2691 protected final function countGenericArrayGroup ($keyGroup, $subGroup) {
2693 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup);
2696 if (!$this->isGenericArrayGroupSet($keyGroup, $subGroup)) {
2698 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.');
2703 $count = count($this->genericArray[$keyGroup][$subGroup]);
2706 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',count=' . $count);
2713 * Count generic array elements
2715 * @param $keyGroup Main group for the key
2716 * @param $subGroup Sub group for the key
2717 * @para $key Key to count
2718 * @return $count Count of given key
2720 protected final function countGenericArrayElements ($keyGroup, $subGroup, $key) {
2722 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2725 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2727 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.');
2729 } elseif (!$this->isValidGenericArrayGroup($keyGroup, $subGroup)) {
2731 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' is not an array.');
2736 $count = count($this->genericArray[$keyGroup][$subGroup][$key]);
2739 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',count=' . $count);
2746 * Getter for whole generic group array
2748 * @param $keyGroup Key group to get
2749 * @return $array Whole generic array group
2751 protected final function getGenericArray ($keyGroup) {
2753 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup);
2756 if (!isset($this->genericArray[$keyGroup])) {
2758 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ' does not exist.');
2763 return $this->genericArray[$keyGroup];
2767 * Setter for generic array key
2769 * @param $keyGroup Key group to get
2770 * @param $subGroup Sub group for the key
2771 * @param $key Key to unset
2772 * @param $value Mixed value from generic array element
2775 protected final function setGenericArrayKey ($keyGroup, $subGroup, $key, $value) {
2777 //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',value[' . gettype($value) . ']=' . print_r($value, TRUE));
2780 $this->genericArray[$keyGroup][$subGroup][$key] = $value;
2784 * Getter for generic array key
2786 * @param $keyGroup Key group to get
2787 * @param $subGroup Sub group for the key
2788 * @param $key Key to unset
2789 * @return $value Mixed value from generic array element
2791 protected final function getGenericArrayKey ($keyGroup, $subGroup, $key) {
2793 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2796 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2798 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' does not exist.');
2803 return $this->genericArray[$keyGroup][$subGroup][$key];
2807 * Sets a value in given generic array key/element
2809 * @param $keyGroup Main group for the key
2810 * @param $subGroup Sub group for the key
2811 * @param $key Key to set
2812 * @param $element Element to set
2813 * @param $value Value to set
2816 protected final function setGenericArrayElement ($keyGroup, $subGroup, $key, $element, $value) {
2818 //* 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));
2821 $this->genericArray[$keyGroup][$subGroup][$key][$element] = $value;
2825 * Getter for generic array element
2827 * @param $keyGroup Key group to get
2828 * @param $subGroup Sub group for the key
2829 * @param $key Key to look for
2830 * @param $element Element to look for
2831 * @return $value Mixed value from generic array element
2833 protected final function getGenericArrayElement ($keyGroup, $subGroup, $key, $element) {
2835 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element);
2838 if (!$this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element)) {
2840 trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ' does not exist.');
2845 return $this->genericArray[$keyGroup][$subGroup][$key][$element];
2849 * Checks if a given sub group is valid (array)
2851 * @param $keyGroup Key group to get
2852 * @param $subGroup Sub group for the key
2853 * @return $isValid Whether given sub group is valid
2855 protected final function isValidGenericArrayGroup ($keyGroup, $subGroup) {
2857 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup);
2860 $isValid = (($this->isGenericArrayGroupSet($keyGroup, $subGroup)) && (is_array($this->getGenericSubArray($keyGroup, $subGroup))));
2867 * Checks if a given key is valid (array)
2869 * @param $keyGroup Key group to get
2870 * @param $subGroup Sub group for the key
2871 * @param $key Key to check
2872 * @return $isValid Whether given sub group is valid
2874 protected final function isValidGenericArrayKey ($keyGroup, $subGroup, $key) {
2876 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2879 $isValid = (($this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) && (is_array($this->getGenericArrayKey($keyGroup, $subGroup, $key))));
2886 * Translates boolean TRUE to 'Y' and FALSE to 'N'
2888 * @param $boolean Boolean value
2889 * @return $translated Translated boolean value
2891 public static final function translateBooleanToYesNo ($boolean) {
2892 // Make sure it is really boolean
2893 assert(is_bool($boolean));
2896 $translated = ($boolean === TRUE) ? 'Y' : 'N';
2898 // ... and return it