3 namespace CoreFramework\Iterator\!!!;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Iterator\BaseIterator;
14 * @author Roland Haeder <webmaster@ship-simu.org>
16 <<<<<<< HEAD:framework/main/classes/iterator/class_
17 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
19 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
20 >>>>>>> Some updates::inc/main/classes/iterator/class_
21 * @license GNU GPL 3.0 or any newer version
22 * @link http://www.ship-simu.org
24 * This program is free software: you can redistribute it and/or modify
25 * it under the terms of the GNU General Public License as published by
26 * the Free Software Foundation, either version 3 of the License, or
27 * (at your option) any later version.
29 * This program is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU General Public License for more details.
34 * You should have received a copy of the GNU General Public License
35 * along with this program. If not, see <http://www.gnu.org/licenses/>.
37 class ???Iterator extends BaseIterator implements Iterator {
39 * Protected constructor
43 protected function __construct () {
44 // Call parent constructor
45 parent::__construct(__CLASS__);
49 * Creates an instance of this class
51 * @return $iteratorInstance An instance of a Iterator class
53 public final static function create???Iterator () {
55 $iteratorInstance = new ???Iterator();
57 // Return the prepared instance
58 return $iteratorInstance;
62 * Getter for current value from group or generic
64 * @return $current Current value in iteration
66 public function current () {
70 $this->partialStub('Please implement this method.');
77 * Getter for key from group or generic
79 * @return $key Current key in iteration
81 public function key () {
85 $this->partialStub('Please implement this method.');
92 * Advances to the next entry
96 public function next () {
97 $this->partialStub('Please implement this method.');
101 * Rewinds to the beginning of the iteration
105 public function rewind () {
106 $this->partialStub('Please implement this method.');
110 * Checks wether the current entry is valid (not at the end of the list)
114 public function valid () {
115 $this->partialStub('Please implement this method.');