]> git.mxchange.org Git - core.git/blob - framework/main/classes/iterator/class_
Some updates:
[core.git] / framework / main / classes / iterator / class_
1 <?php
2 // Own namespace
3 namespace CoreFramework\Iterator\!!!;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Iterator\BaseIterator;
7
8 // Import SPL stuff
9 use \Iterator;
10
11 /**
12  * A ??? iterator
13  *
14  * @author              Roland Haeder <webmaster@ship-simu.org>
15  * @version             0.0.0
16 <<<<<<< HEAD:framework/main/classes/iterator/class_
17  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
18 =======
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
23  *
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.
28  *
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.
33  *
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/>.
36  */
37 class ???Iterator extends BaseIterator implements Iterator {
38         /**
39          * Protected constructor
40          *
41          * @return      void
42          */
43         protected function __construct () {
44                 // Call parent constructor
45                 parent::__construct(__CLASS__);
46         }
47
48         /**
49          * Creates an instance of this class
50          *
51          * @return      $iteratorInstance       An instance of a Iterator class
52          */
53         public final static function create???Iterator () {
54                 // Get new instance
55                 $iteratorInstance = new ???Iterator();
56
57                 // Return the prepared instance
58                 return $iteratorInstance;
59         }
60
61         /**
62          * Getter for current value from group or generic
63          *
64          * @return      $current        Current value in iteration
65          */
66         public function current () {
67                 // Default is null
68                 $current = null;
69
70                 $this->partialStub('Please implement this method.');
71
72                 // Return it
73                 return $current;
74         }
75
76         /**
77          * Getter for key from group or generic
78          *
79          * @return      $key    Current key in iteration
80          */
81         public function key () {
82                 // Default is null
83                 $key = null;
84
85                 $this->partialStub('Please implement this method.');
86
87                 // Return it
88                 return $key;
89         }
90
91         /**
92          * Advances to the next entry
93          *
94          * @return      void
95          */
96         public function next () {
97                 $this->partialStub('Please implement this method.');
98         }
99
100         /**
101          * Rewinds to the beginning of the iteration
102          *
103          * @return      void
104          */
105         public function rewind () {
106                 $this->partialStub('Please implement this method.');
107         }
108
109         /**
110          * Checks wether the current entry is valid (not at the end of the list)
111          *
112          * @return      void
113          */
114         public function valid () {
115                 $this->partialStub('Please implement this method.');
116         }
117
118 }