3 namespace CoreFramework\Iterator\!!!;
5 // Import framework stuff
6 use CoreFramework\Iterator\BaseIterator;
11 * @author Roland Haeder <webmaster@ship-simu.org>
13 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
14 * @license GNU GPL 3.0 or any newer version
15 * @link http://www.ship-simu.org
17 * This program is free software: you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation, either version 3 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 class ???Iterator extends BaseIterator implements Iterator {
32 * Protected constructor
36 protected function __construct () {
37 // Call parent constructor
38 parent::__construct(__CLASS__);
42 * Creates an instance of this class
44 * @return $iteratorInstance An instance of a Iterator class
46 public final static function create???Iterator () {
48 $iteratorInstance = new ???Iterator();
50 // Return the prepared instance
51 return $iteratorInstance;
55 * Getter for current value from group or generic
57 * @return $current Current value in iteration
59 public function current () {
63 $this->partialStub('Please implement this method.');
70 * Getter for key from group or generic
72 * @return $key Current key in iteration
74 public function key () {
78 $this->partialStub('Please implement this method.');
85 * Advances to the next entry
89 public function next () {
90 $this->partialStub('Please implement this method.');
94 * Rewinds to the beginning of the iteration
98 public function rewind () {
99 $this->partialStub('Please implement this method.');
103 * Checks wether the current entry is valid (not at the end of the list)
107 public function valid () {
108 $this->partialStub('Please implement this method.');