3 namespace CoreFramework\Iterator\Registry;
5 // Import framework stuff
6 use CoreFramework\Iterator\BaseIterator;
7 use CoreFramework\Registry\Register;
15 * @author Roland Haeder <webmaster@ship-simu.org>
17 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
18 * @license GNU GPL 3.0 or any newer version
19 * @link http://www.ship-simu.org
21 * This program is free software: you can redistribute it and/or modify
22 * it under the terms of the GNU General Public License as published by
23 * the Free Software Foundation, either version 3 of the License, or
24 * (at your option) any later version.
26 * This program is distributed in the hope that it will be useful,
27 * but WITHOUT ANY WARRANTY; without even the implied warranty of
28 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
29 * GNU General Public License for more details.
31 * You should have received a copy of the GNU General Public License
32 * along with this program. If not, see <http://www.gnu.org/licenses/>.
34 class RegistryIterator extends BaseIterator implements Iterator {
36 * Protected constructor
40 protected function __construct () {
41 // Call parent constructor
42 parent::__construct(__CLASS__);
46 * Creates an instance of this class
48 * @param $registryInstance An instance of a Register class
49 * @return $iteratorInstance An instance of a Iterator class
51 public final static function createRegistryIterator (Register $registryInstance) {
53 $iteratorInstance = new RegistryIterator();
56 $iteratorInstance->setRegistryInstance($registryInstance);
58 // Return the prepared instance
59 return $iteratorInstance;
63 * Getter for current value from group or generic
65 * @return $current Current value in iteration
67 public function current () {
71 $this->partialStub('Please implement this method.');
78 * Getter for key from group or generic
80 * @return $key Current key in iteration
82 public function key () {
86 $this->partialStub('Please implement this method.');
93 * Advances to the next entry
97 public function next () {
98 $this->partialStub('Please implement this method.');
102 * Rewinds to the beginning of the iteration
106 public function rewind () {
107 $this->partialStub('Please implement this method.');
111 * Checks wether the current entry is valid (not at the end of the list)
115 public function valid () {
116 $this->partialStub('Please implement this method.');