Continued with renaming-season:

[core.git] / framework / main / classes / lists / groups / class_ListGroupList.php

diff --git a/framework/main/classes/lists/groups/class_ListGroupList.php b/framework/main/classes/lists/groups/class_ListGroupList.php
new file mode 100644 (file)
index 0000000..096f72c
--- /dev/null
+++ b/framework/main/classes/lists/groups/class_ListGroupList.php
@@ -0,0 +1,70 @@
+<?php
+// Own namespace
+namespace CoreFramework\List\Group;
+
+/**
+ * A ListGroup list
+ *
+ * @author             Roland Haeder <webmaster@shipsimu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.shipsimu.org
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+class ListGroupList extends BaseList implements Listable {
+       /**
+        * Protected constructor
+        *
+        * @return      void
+        */
+       protected function __construct () {
+               // Call parent constructor
+               parent::__construct(__CLASS__);
+       }
+
+       /**
+        * Creates an instance of this class
+        *
+        * @return      $listInstance   An instance a Listable class
+        */
+       public static final function createListGroupList () {
+               // Get new instance
+               $listInstance = new ListGroupList();
+
+               // Return the prepared instance
+               return $listInstance;
+       }
+
+       /**
+        * "Getter" for an iterator instance of this list (not implemented)
+        *
+        * @return      $iteratorInstance       An instance of a Iterator class
+        */
+       public function getListIterator () {
+               $this->debugInstance($this->__toString() . ' uses the default iterator. Please call getIterator() instead!');
+       }
+
+       /**
+        * Clears this list by cleaning up all groups together.
+        *
+        * @return      void
+        * @todo        0% done
+        */
+       public function clearList () {
+               $this->partialStub('Please implement this method.');
+       }
+
+}