Added new interfaces for file i/o classes.

[core.git] / inc / classes / interfaces / class_FrameworkInterface.php

diff --git a/inc/classes/interfaces/class_FrameworkInterface.php b/inc/classes/interfaces/class_FrameworkInterface.php
index 61d098243a5a4c5b9d7d78ad61051e35ae9e1236..88b30bf2a8420c92be395160343eccbff9845a97 100644 (file)
--- a/inc/classes/interfaces/class_FrameworkInterface.php
+++ b/inc/classes/interfaces/class_FrameworkInterface.php
@@ -3,11 +3,11 @@
  * This is the top-level interface for all other interfaces and should contain
  * method stubs which is being used in every class
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @link               http://www.shipsimu.org
  * @todo               Find a better name for this interface
  *
  * This program is free software: you can redistribute it and/or modify
@@ -33,6 +33,15 @@ interface FrameworkInterface {
         */
        function getField ($fieldName);
 
+       /**
+        * Checks whether an object equals this object. You should overwrite this
+        * method to implement own equality checks
+        *
+        * @param       $objectInstance         An instance of a FrameworkInterface object
+        * @return      $equals                         Whether both objects equals
+        */
+       function equals (FrameworkInterface $objectInstance);
+
        /**
         * Generates a code for hashes from this class
         *