X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Fmain%2Fclass_BaseFrameworkSystem.php;h=4207299b8f159ec5852ecb81d219a4882193d8d8;hp=4d354301d0ec80eee22f294c57ef819de9a8bcfa;hb=66e68715d3d5a5e7fd5a3046471914ef3f9dd4b4;hpb=f5cf5211620c1813c76d8231819b63a585fb2689 diff --git a/inc/classes/main/class_BaseFrameworkSystem.php b/inc/classes/main/class_BaseFrameworkSystem.php index 4d354301..4207299b 100644 --- a/inc/classes/main/class_BaseFrameworkSystem.php +++ b/inc/classes/main/class_BaseFrameworkSystem.php @@ -3,11 +3,11 @@ * The simulator system class is the super class of all other classes. This * class handles saving of games etc. * - * @author Roland Haeder + * @author Roland Haeder * @version 0.0.0 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team * @license GNU GPL 3.0 or any newer version - * @link http://www.ship-simu.org + * @link http://www.shipsimu.org * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -193,6 +193,11 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { */ private $packageData = array(); + /** + * Generic array + */ + private $genericArray = array(); + /*********************** * Exception codes.... * ***********************/ @@ -321,10 +326,10 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { $this->setConfigInstance(FrameworkConfiguration::getSelfInstance()); } // END - if - // Is the startup time set? (0 cannot be true anymore) + // Is the startup time set? (0 cannot be TRUE anymore) if (self::$startupTime == 0) { // Then set it - self::$startupTime = microtime(true); + self::$startupTime = microtime(TRUE); } // END - if } @@ -343,10 +348,13 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { $this->setRealClass('DestructedObject'); } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) { // Already destructed object - self::createDebugInstance(__CLASS__)->debugOutput(sprintf("[%s:] The object %s is already destroyed.", + self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:] The object %s is already destroyed.', __CLASS__, $this->__toString() )); + } else { + // Do not call this twice + trigger_error(__METHOD__ . ': Called twice.'); } } @@ -396,11 +404,11 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { // .. or size if array $argsString .= ', ' . count($arg); } elseif ($arg === TRUE) { - // ... is boolean 'true' - $argsString .= ', true'; + // ... is boolean 'TRUE' + $argsString .= ', TRUE'; } elseif ($arg === FALSE) { - // ... is boolean 'true' - $argsString .= ', false'; + // ... is boolean 'FALSE' + $argsString .= ', FALSE'; } // Closing bracket @@ -418,7 +426,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { // Output stub message // @TODO __CLASS__ does always return BaseFrameworkSystem but not the extending (=child) class - self::createDebugInstance(__CLASS__)->debugOutput(sprintf("[unknown::%s:] Stub! Args: %s", + self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[unknown::%s:] Stub! Args: %s', $methodName, $argsString )); @@ -444,7 +452,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * @return void */ public final function __set ($name, $value) { - $this->debugBackTrace(sprintf("Tried to set a missing field. name=%s, value[%s]=%s", + $this->debugBackTrace(sprintf('Tried to set a missing field. name=%s, value[%s]=%s', $name, gettype($value), $value @@ -458,7 +466,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * @return void */ public final function __get ($name) { - $this->debugBackTrace(sprintf("Tried to get a missing field. name=%s", + $this->debugBackTrace(sprintf('Tried to get a missing field. name=%s', $name )); } @@ -470,7 +478,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * @return void */ public final function __unset ($name) { - $this->debugBackTrace(sprintf("Tried to unset a missing field. name=%s", + $this->debugBackTrace(sprintf('Tried to unset a missing field. name=%s', $name )); } @@ -1329,20 +1337,20 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { // Is a message set? if (!empty($message)) { // Construct message - $content = sprintf("
Message: %s
\n", $message); + $content = sprintf('
Message: %s
' . PHP_EOL, $message); } // END - if // Generate the output - $content .= sprintf("
%s
", + $content .= sprintf('
%s
', trim( htmlentities( - print_r($this, true) + print_r($this, TRUE) ) ) ); // Output it - ApplicationEntryPoint::app_exit(sprintf("
%s debug output:
%s
\nLoaded includes:
%s
", + ApplicationEntryPoint::app_exit(sprintf('
%s debug output:
%s
Loaded includes:
%s
', $this->__toString(), $content, ClassLoader::getSelfInstance()->getPrintableIncludeList() @@ -1409,7 +1417,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * Outputs a debug backtrace and stops further script execution * * @param $message An optional message to output - * @param $doExit Whether exit the program (true is default) + * @param $doExit Whether exit the program (TRUE is default) * @return void */ public function debugBackTrace ($message = '', $doExit = TRUE) { @@ -1455,6 +1463,17 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { return $debugInstance; } + /** + * Simple output of a message with line-break + * + * @param $message Message to output + * @return void + */ + public function outputLine ($message) { + // Simply output it + print($message . PHP_EOL); + } + /** * Outputs a debug message whether to debug instance (should be set!) or * dies with or ptints the message. Do NEVER EVER rewrite the exit() call to @@ -1462,7 +1481,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { * * @param $message Message we shall send out... * @param $doPrint Whether print or die here (default: print) - * @paran $stripTags Whether to strip tags (default: false) + * @paran $stripTags Whether to strip tags (default: FALSE) * @return void */ public function debugOutput ($message, $doPrint = TRUE, $stripTags = FALSE) { @@ -1496,7 +1515,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { // Put directly out if ($doPrint === TRUE) { // Print message - print($message . chr(10)); + $this->outputLine($message); } else { // Die here exit($message); @@ -1699,7 +1718,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { // Get current array $fieldArray = $resultInstance->current(); - //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($fieldName.':
'.print_r($fieldArray, true).'
'); + //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($fieldName.':
'.print_r($fieldArray, TRUE).'
'); // Convert dashes to underscore $fieldName = $this->convertDashesToUnderscores($fieldName); @@ -1785,7 +1804,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { */ public function getMilliTime () { // Get the time of day as float - $milliTime = gettimeofday(true); + $milliTime = gettimeofday(TRUE); // Return it return $milliTime; @@ -1964,7 +1983,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { */ protected function isBase64Encoded ($encodedData) { // Determine it - $isBase64 = (@base64_decode($encodedData, true) !== FALSE); + $isBase64 = (@base64_decode($encodedData, TRUE) !== FALSE); // Return it return $isBase64; @@ -2024,7 +2043,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { */ protected function getPrintableExecutionTime () { // Caculate the execution time - $executionTime = microtime(true) - $this->getStartupTime(); + $executionTime = microtime(TRUE) - $this->getStartupTime(); // Pack it in nice braces $executionTime = sprintf('[ %01.5f ] ', $executionTime); @@ -2109,6 +2128,566 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface { // ... and return it return $isset; } + + /** + * Determines if an element is set in the generic array + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to check + * @param $element Element to check + * @return $isset Whether the given key is set + */ + protected final function isGenericArrayElementSet ($keyGroup, $subGroup, $key, $element) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element); + + // Is it there? + $isset = isset($this->genericArray[$keyGroup][$subGroup][$key][$element]); + + // Return it + return $isset; + } + /** + * Determines if a key is set in the generic array + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to check + * @return $isset Whether the given key is set + */ + protected final function isGenericArrayKeySet ($keyGroup, $subGroup, $key) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key); + + // Is it there? + $isset = isset($this->genericArray[$keyGroup][$subGroup][$key]); + + // Return it + return $isset; + } + + + /** + * Determines if a group is set in the generic array + * + * @param $keyGroup Main group + * @param $subGroup Sub group + * @return $isset Whether the given group is set + */ + protected final function isGenericArrayGroupSet ($keyGroup, $subGroup) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup); + + // Is it there? + $isset = isset($this->genericArray[$keyGroup][$subGroup]); + + // Return it + return $isset; + } + + /** + * Getter for sub key group + * + * @param $keyGroup Main key group + * @param $subGroup Sub key group + * @return $array An array with all array elements + */ + protected final function getGenericSubArray ($keyGroup, $subGroup) { + // Is it there? + if (!$this->isGenericArrayGroupSet($keyGroup, $subGroup)) { + // No, then abort here + trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.'); + } // END - if + + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',value=' . print_r($this->genericArray[$keyGroup][$subGroup], TRUE)); + + // Return it + return $this->genericArray[$keyGroup][$subGroup]; + } + + /** + * Unsets a given key in generic array + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to unset + * @return void + */ + protected final function unsetGenericArrayKey ($keyGroup, $subGroup, $key) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key); + + // Remove it + unset($this->genericArray[$keyGroup][$subGroup][$key]); + } + + /** + * Unsets a given element in generic array + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to unset + * @param $element Element to unset + * @return void + */ + protected final function unsetGenericArrayElement ($keyGroup, $subGroup, $key, $element) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element); + + // Remove it + unset($this->genericArray[$keyGroup][$subGroup][$key][$element]); + } + + /** + * Append a string to a given generic array key + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to unset + * @param $value Value to add/append + * @return void + */ + protected final function appendStringToGenericArrayKey ($keyGroup, $subGroup, $key, $value, $appendGlue = '') { + // Debug message + //* 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); + + // Is it already there? + if ($this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) { + // Append it + $this->genericArray[$keyGroup][$subGroup][$key] .= $appendGlue . (string) $value; + } else { + // Add it + $this->genericArray[$keyGroup][$subGroup][$key] = (string) $value; + } + } + + /** + * Append a string to a given generic array element + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to unset + * @param $element Element to check + * @param $value Value to add/append + * @return void + */ + protected final function appendStringToGenericArrayElement ($keyGroup, $subGroup, $key, $element, $value, $appendGlue = '') { + // Debug message + //* 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); + + // Is it already there? + if ($this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element)) { + // Append it + $this->genericArray[$keyGroup][$subGroup][$key][$element] .= $appendGlue . (string) $value; + } else { + // Add it + $this->genericArray[$keyGroup][$subGroup][$key][$element] = (string) $value; + } + } + + /** + * Initializes given generic array group + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to use + * @param $forceInit Optionally force initialization + * @return void + */ + protected final function initGenericArrayGroup ($keyGroup, $subGroup, $forceInit = FALSE) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',forceInit=' . intval($forceInit)); + + // Is it already set? + if (($forceInit === FALSE) && ($this->isGenericArrayGroupSet($keyGroup, $subGroup))) { + // Already initialized + trigger_error(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' already initialized.'); + } // END - if + + // Initialize it + $this->genericArray[$keyGroup][$subGroup] = array(); + } + + /** + * Initializes given generic array key + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to use + * @param $forceInit Optionally force initialization + * @return void + */ + protected final function initGenericArrayKey ($keyGroup, $subGroup, $key, $forceInit = FALSE) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',forceInit=' . intval($forceInit)); + + // Is it already set? + if (($forceInit === FALSE) && ($this->isGenericArrayKeySet($keyGroup, $subGroup, $key))) { + // Already initialized + trigger_error(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' already initialized.'); + } // END - if + + // Initialize it + $this->genericArray[$keyGroup][$subGroup][$key] = array(); + } + + /** + * Initializes given generic array element + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to use + * @param $element Element to use + * @param $forceInit Optionally force initialization + * @return void + */ + protected final function initGenericArrayElement ($keyGroup, $subGroup, $key, $element, $forceInit = FALSE) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',forceInit=' . intval($forceInit)); + + // Is it already set? + if (($forceInit === FALSE) && ($this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element))) { + // Already initialized + trigger_error(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ' already initialized.'); + } // END - if + + // Initialize it + $this->genericArray[$keyGroup][$subGroup][$key][$element] = array(); + } + + /** + * Pushes an element to a generic key + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to use + * @param $value Value to add/append + * @return $count Number of array elements + */ + protected final function pushValueToGenericArrayKey ($keyGroup, $subGroup, $key, $value) { + // Debug message + //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',value[' . gettype($value) . ']=' . print_r($value, TRUE)); + + // Is it set? + if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) { + // Initialize array + $this->initGenericArrayKey($keyGroup, $subGroup, $key); + } // END - if + + // Then push it + $count = array_push($this->genericArray[$keyGroup][$subGroup][$key], $value); + + // Return count + //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE)); + //* DEBUG: */ print(__METHOD__ . ': count=' . $count . PHP_EOL); + return $count; + } + + /** + * Pushes an element to a generic array element + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to use + * @param $element Element to check + * @param $value Value to add/append + * @return $count Number of array elements + */ + protected final function pushValueToGenericArrayElement ($keyGroup, $subGroup, $key, $element, $value) { + // Debug message + //* 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)); + + // Is it set? + if (!$this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element)) { + // Initialize array + $this->initGenericArrayElement($keyGroup, $subGroup, $key, $element); + } // END - if + + // Then push it + $count = array_push($this->genericArray[$keyGroup][$subGroup][$key][$element], $value); + + // Return count + //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE)); + //* DEBUG: */ print(__METHOD__ . ': count=' . $count . PHP_EOL); + return $count; + } + + /** + * Pops an element from a generic group + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to unset + * @return $value Last "popped" value + */ + protected final function popGenericArrayElement ($keyGroup, $subGroup, $key) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key); + + // Is it set? + if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) { + // Not found + trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' not found.'); + } // END - if + + // Then "pop" it + $value = array_pop($this->genericArray[$keyGroup][$subGroup][$key]); + + // Return value + //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE)); + //* DEBUG: */ print(__METHOD__ . ': value[' . gettype($value) . ']=' . print_r($value, TRUE) . PHP_EOL); + return $value; + } + + /** + * Shifts an element from a generic group + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to unset + * @return $value Last "popped" value + */ + protected final function shiftGenericArrayElement ($keyGroup, $subGroup, $key) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key); + + // Is it set? + if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) { + // Not found + trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' not found.'); + } // END - if + + // Then "shift" it + $value = array_shift($this->genericArray[$keyGroup][$subGroup][$key]); + + // Return value + //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE)); + //* DEBUG: */ print(__METHOD__ . ': value[' . gettype($value) . ']=' . print_r($value, TRUE) . PHP_EOL); + return $value; + } + + /** + * Count generic array group + * + * @param $keyGroup Main group for the key + * @return $count Count of given group + */ + protected final function countGenericArray ($keyGroup) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup); + + // Is it there? + if (!isset($this->genericArray[$keyGroup])) { + // Abort here + trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ' not found.'); + } // END - if + + // Then count it + $count = count($this->genericArray[$keyGroup]); + + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',count=' . $count); + + // Return it + return $count; + } + + /** + * Count generic array sub group + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @return $count Count of given group + */ + protected final function countGenericArrayGroup ($keyGroup, $subGroup) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup); + + // Is it there? + if (!$this->isGenericArrayGroupSet($keyGroup, $subGroup)) { + // Abort here + trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.'); + } // END - if + + // Then count it + $count = count($this->genericArray[$keyGroup][$subGroup]); + + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',count=' . $count); + + // Return it + return $count; + } + + /** + * Count generic array elements + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @para $key Key to count + * @return $count Count of given key + */ + protected final function countGenericArrayElements ($keyGroup, $subGroup, $key) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key); + + // Is it there? + if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) { + // Abort here + trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.'); + } elseif (!$this->isValidGenericArrayGroup($keyGroup, $subGroup)) { + // Not valid + trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' is not an array.'); + } + + // Then count it + $count = count($this->genericArray[$keyGroup][$subGroup][$key]); + + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',count=' . $count); + + // Return it + return $count; + } + + /** + * Getter for whole generic group array + * + * @param $keyGroup Key group to get + * @return $array Whole generic array group + */ + protected final function getGenericArray ($keyGroup) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup); + + // Is it there? + if (!isset($this->genericArray[$keyGroup])) { + // Then abort here + trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ' does not exist.'); + } // END - if + + // Return it + return $this->genericArray[$keyGroup]; + } + + /** + * Setter for generic array key + * + * @param $keyGroup Key group to get + * @param $subGroup Sub group for the key + * @param $key Key to unset + * @param $value Mixed value from generic array element + * @return void + */ + protected final function setGenericArrayKey ($keyGroup, $subGroup, $key, $value) { + // Debug message + //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',value[' . gettype($value) . ']=' . print_r($value, TRUE)); + + // Set value here + $this->genericArray[$keyGroup][$subGroup][$key] = $value; + } + + /** + * Getter for generic array key + * + * @param $keyGroup Key group to get + * @param $subGroup Sub group for the key + * @param $key Key to unset + * @return $value Mixed value from generic array element + */ + protected final function getGenericArrayKey ($keyGroup, $subGroup, $key) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key); + + // Is it there? + if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) { + // Then abort here + trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' does not exist.'); + } // END - if + + // Return it + return $this->genericArray[$keyGroup][$subGroup][$key]; + } + + /** + * Sets a value in given generic array key/element + * + * @param $keyGroup Main group for the key + * @param $subGroup Sub group for the key + * @param $key Key to set + * @param $element Element to set + * @param $value Value to set + * @return void + */ + protected final function setGenericArrayElement ($keyGroup, $subGroup, $key, $element, $value) { + // Debug message + //* 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)); + + // Then set it + $this->genericArray[$keyGroup][$subGroup][$key][$element] = $value; + } + + /** + * Getter for generic array element + * + * @param $keyGroup Key group to get + * @param $subGroup Sub group for the key + * @param $key Key to look for + * @param $element Element to look for + * @return $value Mixed value from generic array element + */ + protected final function getGenericArrayElement ($keyGroup, $subGroup, $key, $element) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element); + + // Is it there? + if (!$this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element)) { + // Then abort here + trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ' does not exist.'); + } // END - if + + // Return it + return $this->genericArray[$keyGroup][$subGroup][$key][$element]; + } + + /** + * Checks if a given sub group is valid (array) + * + * @param $keyGroup Key group to get + * @param $subGroup Sub group for the key + * @return $isValid Whether given sub group is valid + */ + protected final function isValidGenericArrayGroup ($keyGroup, $subGroup) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup); + + // Determine it + $isValid = (($this->isGenericArrayGroupSet($keyGroup, $subGroup)) && (is_array($this->getGenericSubArray($keyGroup, $subGroup)))); + + // Return it + return $isValid; + } + + /** + * Checks if a given key is valid (array) + * + * @param $keyGroup Key group to get + * @param $subGroup Sub group for the key + * @param $key Key to check + * @return $isValid Whether given sub group is valid + */ + protected final function isValidGenericArrayKey ($keyGroup, $subGroup, $key) { + // Debug message + //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key); + + // Determine it + $isValid = (($this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) && (is_array($this->getGenericArrayKey($keyGroup, $subGroup, $key)))); + + // Return it + return $isValid; + } } // [EOF]