X-Git-Url: https://git.mxchange.org/?p=shipsimu.git;a=blobdiff_plain;f=inc%2Fclasses%2Finterfaces%2Fclass_FrameworkInterface.php;h=8d808b4decfd9f9e5f0ed92ef30f717a9b6ef56f;hp=3c9d5ff52b9a5fc430785e8ab9704971716df78b;hb=efba981c9bf18c733dfde945b09111ff4b6007ce;hpb=ff66822b5fb6a92f5dc8af55290ecb89ec7f1aaf diff --git a/inc/classes/interfaces/class_FrameworkInterface.php b/inc/classes/interfaces/class_FrameworkInterface.php index 3c9d5ff..8d808b4 100644 --- a/inc/classes/interfaces/class_FrameworkInterface.php +++ b/inc/classes/interfaces/class_FrameworkInterface.php @@ -4,9 +4,10 @@ * method stubs which is being used in every class * * @author Roland Haeder - * @version 0.0 - * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software + * @version 0.0.0 + * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software * @license GNU GPL 3.0 or any newer version + * @link http://www.ship-simu.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 @@ -19,9 +20,27 @@ * 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 . + * along with this program. If not, see . */ interface FrameworkInterface { + /** + * Getter for field name + * + * @param $fieldName Field name which we shall get + * @return $fieldValue Field value from the user + * @throws NullPointerException If the result instance is null + */ + function getField ($fieldName); + + /** + * Updates a given field with new value + * + * @param $fieldName Field to update + * @param $fieldValue New value to store + * @return void + * @throws DatabaseUpdateSupportException If this class does not support database updates + */ + function updateDatabaseField ($fieldName, $fieldValue); } //