Add EmailLogListPage
[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / data / ITraversableObject.class.php
index 0ff9c52f5a978e28d406906c4bdb564440db648c..aa530207296812be17993e8e4f6941eb9bcd4e1f 100644 (file)
@@ -1,28 +1,30 @@
 <?php
+
 namespace wcf\data;
 
 /**
  * Interface for enhanced iteration support.
- * 
- * @author     Alexander Ebert
- * @copyright  2001-2018 WoltLab GmbH
- * @license    GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
- * @package    WoltLabSuite\Core\Data
+ *
+ * @author  Alexander Ebert
+ * @copyright   2001-2019 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @package WoltLabSuite\Core\Data
  */
-interface ITraversableObject extends \SeekableIterator {
-       /**
-        * Sets internal iterator pointer based upon related object id.
-        * 
-        * @param       integer         $objectID
-        */
-       public function seekTo($objectID);
-       
-       /**
-        * Searches a specific object by object id and setting internal iterator
-        * pointer to found item. Returns `null` if object id is not found.
-        * 
-        * @param       integer         $objectID
-        * @return      DatabaseObject|null
-        */
-       public function search($objectID);
+interface ITraversableObject extends \SeekableIterator
+{
+    /**
+     * Sets internal iterator pointer based upon related object id.
+     *
+     * @param int $objectID
+     */
+    public function seekTo($objectID);
+
+    /**
+     * Searches a specific object by object id and setting internal iterator
+     * pointer to found item. Returns `null` if object id is not found.
+     *
+     * @param int $objectID
+     * @return  DatabaseObject|null
+     */
+    public function search($objectID);
 }