X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Finterfaces%2Fclass_FrameworkInterface.php;h=88b30bf2a8420c92be395160343eccbff9845a97;hp=2859d7a3489bea85bfe4607e2dadb5d7d7ce8bbe;hb=0a638eea103f0f2b6c48374cb8d01e68893f5a65;hpb=46a806ba2ea6443c6927242b07f39842581e0eab diff --git a/inc/classes/interfaces/class_FrameworkInterface.php b/inc/classes/interfaces/class_FrameworkInterface.php index 2859d7a3..88b30bf2 100644 --- a/inc/classes/interfaces/class_FrameworkInterface.php +++ b/inc/classes/interfaces/class_FrameworkInterface.php @@ -3,11 +3,12 @@ * 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 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 * it under the terms of the GNU General Public License as published by @@ -32,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 * @@ -40,5 +50,5 @@ interface FrameworkInterface { function hashCode (); } -// +// [EOF] ?>