5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class HubList extends BaseList implements Listable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
36 * Creates an instance of this class
38 * @return $listInstance An instance a Listable class
40 public static final function createHubList () {
42 $listInstance = new HubList();
44 // Add groups for e.g. connected/disconnected hubs
45 $listInstance->addGroup('connected');
46 $listInstance->addGroup('disconnected');
48 // Return the prepared instance
53 * "Getter" for an iterator instance of this list
55 * @return $iteratorInstance An instance of a Iterator class
58 public function getListIterator () {
59 $this->partialStub('Please implement this method.');
63 * Clears this list by cleaning up all groups together.
67 public function clearList () {
68 // Clear both groups together
69 $this->clearGroups(array('connected', 'disconnected'));