X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=inc%2Fclasses%2Finterfaces%2Fclass_FrameworkInterface.php;h=88b30bf2a8420c92be395160343eccbff9845a97;hb=202f8c1c1d46d1292918b7110547952446a53391;hp=1c22f6b7d5f3b26948389f7803f702048970fbcb;hpb=84e2207412d3c6ea9f940a83b2cdd4503509808a;p=core.git diff --git a/inc/classes/interfaces/class_FrameworkInterface.php b/inc/classes/interfaces/class_FrameworkInterface.php index 1c22f6b7..88b30bf2 100644 --- 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 + * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 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 *