X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=framework%2Fmain%2Fclasses%2Fiterator%2Fregistry%2Fclass_RegistryIterator.php;h=731c61acdf9c7253e48eef99a4c09ec680868b11;hp=66538f52ce3a70a03834ddcb96dcb698da9590c6;hb=HEAD;hpb=b954ccaa3dbfc59ddc76e463d2980a5dc204cc9f diff --git a/framework/main/classes/iterator/registry/class_RegistryIterator.php b/framework/main/classes/iterator/registry/class_RegistryIterator.php index 66538f52..731c61ac 100644 --- a/framework/main/classes/iterator/registry/class_RegistryIterator.php +++ b/framework/main/classes/iterator/registry/class_RegistryIterator.php @@ -1,24 +1,28 @@ * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team * @license GNU GPL 3.0 or any newer version * @link http://www.ship-simu.org * @@ -36,29 +40,41 @@ use \LogicException; * along with this program. If not, see . */ class RegistryIterator extends BaseIterator implements IteratableRegistry { + // Load traits + use RegisterTrait; + /** * All found registry keys */ - private $registryKeys = array(); + private $registryKeys = []; /** - * Current array key + * An array containing keys ob sub-registries which keys should only be + * included in the iterator. */ - private $key = NULL; + private $onlyRegistries = []; /** - * Valid status (default: not valid) + * Current array key */ - private $valid = FALSE; + private $key = NULL; /** * Protected constructor * * @return void */ - protected function __construct () { + private function __construct () { // Call parent constructor parent::__construct(__CLASS__); + + // Init registry keys array + $this->registryKeys = [ + // Generic registry + 'generic' => [], + // Instance registry + 'instance' => [], + ]; } /** @@ -69,118 +85,114 @@ class RegistryIterator extends BaseIterator implements IteratableRegistry { */ public final static function createRegistryIterator (Register $registryInstance) { // Get new instance + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('REGISTRY-ITERATOR: registryInstance=%s - CALLED!', $registryInstance->__toString())); $iteratorInstance = new RegistryIterator(); // Set registry here $iteratorInstance->setRegistryInstance($registryInstance); // Return the prepared instance + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('REGISTRY-ITERATOR: iteratorInstance=%s - EXIT!', $iteratorInstance->__toString())); return $iteratorInstance; } + /** + * Setter for only-registries array + * + * @param $onlyRegistries Array with keys only being iterated over + * @return void + */ + private function setOnlyRegistries (array $onlyRegistries) { + $this->onlyRegistries = $onlyRegistries; + } + /** * Initializes this iterator by scanning over the registry for all keys. * - * @param $callbackInstance An instance of a FrameworkInterface class to call back (optional) - * @param $criteriaKey Criteria key (optional) - * @param $criteriaMethod Method to call back (optional) + * @param $onlyRegistries Only iterate on these sub-registry keys, default is all * @return void * @throws LogicException If a registry entry does not implement Registerable * @throws NullPointerException If criteriaKey or criteriaMethod is not set but a call-back instance is set */ - public function initIterator (FrameworkInterface $callbackInstance = NULL, $criteriaKey = NULL, $criteriaMethod = NULL) { - // Is the call-back instance set? - if ($callbackInstance instanceof FrameworkInterface) { - // Then also criteria key and method name must be given - if (is_null($criteriaKey)) { - // Throw NPE - throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER); - } elseif (is_null($criteriaMethod)) { - // Throw NPE - throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER); - } - - // Set all - $iteratorInstance->setCallbackInstance($callbackInstance); - $iteratorInstance->setCriteriaKey($criteriaKey); - } // END - if + public function initIterator (array $onlyRegistries = []) { + // Set it in this registry + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('REGISTRY-ITERATOR: onlyRegistries()=%d - CALLED!', count($onlyRegistries))); + $this->setOnlyRegistries($onlyRegistries); // Get generic registry entries from it $entries = $this->getRegistryInstance()->getGenericRegistry(); - // Init registry keys array - $this->registryKeys['generic'] = array(); - // Anything in there? + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('REGISTRY-ITERATOR: entries()=%d', count($entries))); if (count($entries) > 0) { // Debugging: - /* DEBUG-DIE: */ die(sprintf('[%s:%d]: entries=%s', __METHOD__, __LINE__, print_r($entries, TRUE))); - } // END - if + /* DEBUG-DIE: */ ApplicationEntryPoint::exitApplication(sprintf('[%s:%d]: UNFINISHED: entries=%s', __METHOD__, __LINE__, print_r($entries, TRUE))); + } // Get instance registry entries from it $entries = $this->getRegistryInstance()->getInstanceRegistry(); - // Init registry keys array - $this->registryKeys['instance'] = array(); - // Anything in there? + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('REGISTRY-ITERATOR: entries()=%d', count($entries))); if (count($entries) > 0) { // Then run over all foreach ($entries as $key => $entry) { - // Debug message - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('REGISTRY-ITERATOR[instance]: key=%s,entry[]=%s', $key, gettype($entry))); - - // Is it 'socket_registry' ? - if ($key == 'socket_registry') { - // Skip this entry + // Is an unwanted registry found? + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('REGISTRY-ITERATOR: key=%s,entry[%s]=%s', $key, gettype($entry), $entry->__toString())); + if (substr($key, -8, 8) == 'registry') { + // Skip this! + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('REGISTRY-ITERATOR: key=%s is a registry key, skipping ...', $key)); continue; - } // END - if + } // Is it an instance of a sub-registry? - if ($entry instanceof SubRegistry) { + if (count($onlyRegistries) > 0 && !in_array($key, $onlyRegistries, TRUE)) { + // Not in requested registries + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('REGISTRY-ITERATOR: key=%s is not wanted, skipping ...', $key)); + continue; + } elseif ($entry instanceof ObjectRegistry) { // Get iterator from this instance - $iteratorInstance = $entry->getIterator(); - - // Debugging: - //* DEBUG-DIE: */ die(sprintf('[%s:%d]: key=%s,iteratorInstance=%s', __METHOD__, __LINE__, $key, print_r($iteratorInstance, TRUE))); - - // Get all keys - $keys = $iteratorInstance->getRegistryKeys(); - - // Should be there - if (!isset($keys['instance'])) { - // Should not happen - throw new LogicException(sprintf('key=%s,keys[instance] is not set.', $key)); - } // END - if + $objectRegistryInstances = $entry->getInstanceRegistry(); // Add all sub-registry keys to this registry keys array - $this->registryKeys['instance'][$key] = $keys['instance']; - - // Debug message - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('REGISTRY-ITERATOR[instance]: key=%s,keys=%s', $key, print_r($this->registryKeys['instance'][$key], TRUE))); + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('REGISTRY-ITERATOR: objectRegistryInstances()=%d', count($objectRegistryInstances))); + //* DEBUG-DIE: */ ApplicationEntryPoint::exitApplication(sprintf('[%s:%d]: key=%s,objectRegistryInstances=%s', __METHOD__, __LINE__, $key, print_r($objectRegistryInstances, TRUE))); + foreach (array_keys($objectRegistryInstances) as $subKey) { + // Add it + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('REGISTRY-ITERATOR: Adding key=%s,subKey=%s ...', $key, $subKey)); + array_push($this->registryKeys['instance'], $subKey); + + // Is the current key set? + if (is_null($this->key)) { + // Init key + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('REGISTRY-ITERATOR: Setting this->key=%s as first key (subKey) ...', $subKey)); + $this->key = $subKey; + } + } // Skip below code continue; } elseif (!($entry instanceof Registerable)) { // Not registerable?! - throw new LogicException(sprintf('entry[]=%s does not implement Registerable.', gettype($entry))); - } elseif (is_null($this->key)) { - // Debug message - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('REGISTRY-ITERATOR[instance]: Setting key=%s ...', $key)); + throw new LogicException(sprintf('entry[]=%s does not implement Registerable.', gettype($entry)), FrameworkInterface::EXCEPTION_LOGIC_EXCEPTION); + } - // Init key/valid + // Is the current key set? + if (is_null($this->key)) { + // Init key + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('REGISTRY-ITERATOR: Setting this->key=%s as first key (key) ...', $key)); $this->key = $key; - $this->valid = TRUE; } - // Debugging: - //* DEBUG-DIE: */ die(sprintf('[%s:%d]: key=%s,entry=%s', __METHOD__, __LINE__, $key, print_r($entry, TRUE))); - //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('REGISTRY-ITERATOR[instance]: key=%s,entry[]=%s - Adding ...', $key, gettype($entry))); - // Add key to array - $this->registryKeys['instance'][$key] = array(); - } // END - foreach - } // END - if + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('REGISTRY-ITERATOR: key=%s - Adding ...', $key)); + //* DEBUG-DIE: */ ApplicationEntryPoint::exitApplication(sprintf('[%s:%d]: key=%s,entry=%s', __METHOD__, __LINE__, $key, print_r($entry, TRUE))); + array_push($this->registryKeys['instance'], $key); + } + } + + // Trace message + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('REGISTRY-ITERATOR: EXIT!'); } /** @@ -197,14 +209,52 @@ class RegistryIterator extends BaseIterator implements IteratableRegistry { * Getter for current value from group or generic * * @return $current Current value in iteration + * @throws NullPointerException If current key points to a non-existing entry in searched registries */ public function current () { // Default is null - $current = null; + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('REGISTRY-ITERATOR[%s]: CALLED!', $this->key())); + //* DEBUG-DIE: */ ApplicationEntryPoint::exitApplication(sprintf('[%s:%d]: this->key(%d)[%s]=%s,this->valid=%d,this->registryKeys=%s', __METHOD__, __LINE__, strlen($this->key()), gettype($this->key()), $this->key(), intval($this->valid()), print_r($this->registryKeys, TRUE))); + $current = NULL; + $entries = []; + + // Get all registries + $allRegistries = $this->getRegistryInstance()->getInstanceRegistry(); + + // Loop through all sub-sets + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('REGISTRY-ITERATOR[%s]: allRegistries()=%d', $this->key(), count($allRegistries))); + foreach ($allRegistries as $registryKey => $registryInstance) { + // Is this key wanted? + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('REGISTRY-ITERATOR[%s]: registryKey=%s', $this->key(), $registryKey)); + if (count($this->onlyRegistries) == 0 || in_array($registryKey, $this->onlyRegistries)) { + // Yes, then loop through them only + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('REGISTRY-ITERATOR[%s]: registryKey=%s,this->onlyRegistries()=%d', $this->key(), $registryKey, count($this->onlyRegistries))); + $instances = $registryInstance->getInstanceRegistry(); + + // The key should be there + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('REGISTRY-ITERATOR[%s]: Handling instances()=%d,registryKey=%s ...', $this->key(), count($instances), $registryKey)); + if (!isset($instances[$this->key()])) { + // Not found + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->warningMessage(sprintf('REGISTRY-ITERATOR[%s]: registryKey=%s has no this->key=%s - CONTINUE!', $this->key(), $registryKey, $this->key())); + continue; + } + + // Set as current + $current = $instances[$this->key()]; + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('REGISTRY-ITERATOR[%s]: current=%s', $this->key(), $current->__toString())); + break; + } + } - $this->partialStub('Please implement this method.'); + // Is current still NULL? + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('REGISTRY-ITERATOR[%s]: registryKey=%s,current[]=%s', $this->key(), $registryKey, gettype($current))); + if (is_null($current)) { + // This cannot happen and indicates a logic error + throw new NullPointerException($this, FrameworkInterface::EXCEPTION_IS_NULL_POINTER); + } // Return it + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('REGISTRY-ITERATOR[%s]: current[%s]=%s - EXIT!', $this->key(), gettype($current), $current)); return $current; } @@ -215,6 +265,7 @@ class RegistryIterator extends BaseIterator implements IteratableRegistry { */ public function key () { // Return it + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('REGISTRY-ITERATOR: this->key=%s EXIT!', $this->key)); return $this->key; } @@ -222,19 +273,87 @@ class RegistryIterator extends BaseIterator implements IteratableRegistry { * Advances to the next entry * * @return void + * @throws BadMethodCallException If $this->valid() returns FALSE + * @throws UnexpectedValueException If $registryType is not changed */ public function next () { - $this->partialStub('Please implement this method.'); + // Is valid() still TRUE? + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('REGISTRY-ITERATOR[%s]: CALLED!', $this->key())); + //* DEBUG-DIE: */ ApplicationEntryPoint::exitApplication(sprintf('[%s:%d]: this->key(%d)[%s]=%s,this->valid=%d,this->registryKeys=%s', __METHOD__, __LINE__, strlen($this->key()), gettype($this->key()), $this->key(), intval($this->valid()), print_r($this->registryKeys, TRUE))); + if (!$this->valid()) { + // Bad method call! + throw new BadMethodCallException(sprintf('this->key[%s]=%s is no longer valid, but method was called.', gettype($this->key()), $this->key()), FrameworkInterface::EXCEPTION_BAD_METHOD_CALL); + } elseif ((count($this->registryKeys['generic']) == 0) && (count($this->registryKeys['instance']) == 0)) { + // Both arrays are empty + throw new BadMethodCallException('No array elements in "generic" and "instance" found but method called.', FrameworkInterface::EXCEPTION_BAD_METHOD_CALL); + } + + // Default is not valid + $nextIndex = -1; + $isNextValid = FALSE; + $registryType = 'invalid'; + + // Get first array element ... + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('REGISTRY-ITERATOR[%s]: this->registryKeys[generic]()=%d,this->registryKeys[instance]()=%d', $this->key(), count($this->registryKeys['generic']), count($this->registryKeys['instance']))); + if (count($this->registryKeys['generic']) > 0) { + // First generic array + /* UNFINISHED */ ApplicationEntryPoint::exitApplication(sprintf('[%s:%d]: this->key(%d)[%s]=%s,this->valid=%d,this->registryKeys=%s', __METHOD__, __LINE__, strlen($this->key()), gettype($this->key()), $this->key(), intval($this->valid()), print_r($this->registryKeys, TRUE))); + } elseif (count($this->registryKeys['instance']) > 0) { + // Second instance, current key's index + 1 + $nextIndex = array_search($this->key(), $this->registryKeys['instance']) + 1; + $isNextValid = isset($this->registryKeys['instance'][$nextIndex]); + $registryType = 'instance'; + } + + // Is it still valid? + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('REGISTRY-ITERATOR[%s]: isNextValid=%d', $this->key(), intval($isNextValid))); + if (!$isNextValid) { + // Throw exception + throw new BadMethodCallException(sprintf('this->key=%s is last key in this iteration. Forgot to invoke valid() before?', $this->key()), FrameworkInterface::EXCEPTION_BAD_METHOD_CALL); + } elseif ($registryType == 'invalid') { + // Not changed! + throw new UnexpectedValueException('registryType has not been changed.', FrameworkInterface::EXCEPTION_UNEXPECTED_VALUE); + } + + // Yes, then advance to that entry + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('REGISTRY-ITERATOR: Setting this->key from this->registryKeys[%s][%d] ...', $registryType, $nextIndex)); + $this->key = $this->registryKeys[$registryType][$nextIndex]; + + // Trace message + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('REGISTRY-ITERATOR[%s]: EXIT!', $this->key())); } /** * Rewinds to the beginning of the iteration * * @return void + * @throws BadMethodCallException If $this->key is already the first element */ public function rewind () { - // Debugging: - /* DEBUG-DIE: */ die(sprintf('[%s:%d]: this->key(%d)[%s]=%s,this->valid=%d,this->registryKeys=%s', __METHOD__, __LINE__, strlen($this->key()), gettype($this->key()), $this->key(), intval($this->valid()), print_r($this->registryKeys, TRUE))); + // Is current key first key? + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('REGISTRY-ITERATOR[%s]: CALLED!', $this->key())); + //* DEBUG-DIE: */ ApplicationEntryPoint::exitApplication(sprintf('[%s:%d]: this->key(%d)[%s]=%s,this->valid=%d,this->registryKeys=%s', __METHOD__, __LINE__, strlen($this->key()), gettype($this->key()), $this->key(), intval($this->valid()), print_r($this->registryKeys, TRUE))); + if (array_search($this->key(), $this->getRegistryKeys()) === 0) { + // rewind() cannot rewind first entry! + throw new BadMethodCallException(sprintf('this->key=%s is already first element, but method was called.', $this->key()), FrameworkInterface::EXCEPTION_BAD_METHOD_CALL); + } elseif ((count($this->registryKeys['generic']) == 0) && (count($this->registryKeys['instance']) == 0)) { + // Both arrays are empty + throw new BadMethodCallException('No array elements in "generic" and "instance" found but method called.', FrameworkInterface::EXCEPTION_BAD_METHOD_CALL); + } + + // Get first array element ... + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage(sprintf('REGISTRY-ITERATOR[%s]: this->registryKeys[generic]()=%d,this->registryKeys[instance]()=%d', $this->key(), count($this->registryKeys['generic']), count($this->registryKeys['instance']))); + if (count($this->registryKeys['generic']) > 0) { + // First generic array + /* UNFINISHED */ ApplicationEntryPoint::exitApplication(sprintf('[%s:%d]: this->key(%d)[%s]=%s,this->valid=%d,this->registryKeys=%s', __METHOD__, __LINE__, strlen($this->key()), gettype($this->key()), $this->key(), intval($this->valid()), print_r($this->registryKeys, TRUE))); + } elseif (count($this->registryKeys['instance']) > 0) { + // Second instance + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage('REGISTRY-ITERATOR: Setting this->key from this->registryKeys[instance][0] ...'); + $this->key = $this->registryKeys['instance'][0]; + } + + // Trace message + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('REGISTRY-ITERATOR[%s]: EXIT!', $this->key())); } /** @@ -243,8 +362,14 @@ class RegistryIterator extends BaseIterator implements IteratableRegistry { * @return $valid Whether the current key is still valid */ public function valid () { + // Is the element there? + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('REGISTRY-ITERATOR[%s]: CALLED!', $this->key())); + //* DEBUG-DIE: */ ApplicationEntryPoint::exitApplication(sprintf('[%s:%d]: this->key(%d)[%s]=%s,this->registryKeys=%s', __METHOD__, __LINE__, strlen($this->key()), gettype($this->key()), $this->key(), print_r($this->registryKeys, TRUE))); + $valid = (in_array($this->key(), $this->registryKeys['instance']) || in_array($this->key(), $this->registryKeys['generic'])); + // Return flag - return $this->valid; + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('REGISTRY-ITERATOR[%s]: valid=%d - EXIT!', $this->key(), intval($valid))); + return $valid; } }