Renamed 'ship-simu' to 'shipsimu' + added 'core' and symlink to core/inc

[shipsimu.git] / application / shipsimu / main / bank / class_BaseBank.php

diff --git a/application/shipsimu/main/bank/class_BaseBank.php b/application/shipsimu/main/bank/class_BaseBank.php
new file mode 100644 (file)
index 0000000..21ae0d5
--- /dev/null
+++ b/application/shipsimu/main/bank/class_BaseBank.php
@@ -0,0 +1,60 @@
+<?php
+/**
+ * A general bank class
+ *
+ * @author             Roland Haeder <webmaster@shipsimu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Ship-Simu Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ * @link               http://www.shipsimu.org
+ * @todo               Find an instance for all banks and move the abstract functions there
+ *
+ * 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
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * 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 <http://www.gnu.org/licenses/>.
+ */
+abstract class BaseBank extends BaseFrameworkSystem {
+       /**
+        * Protected constructor
+        *
+        * @param       $className      The class' real name
+        * @return      void
+        */
+       protected function __construct ($className) {
+               // Call parent constructor
+               parent::__construct($className);
+       }
+
+       /**
+        * Checks wether the bank lends more money to the current user
+        *
+        * @return      $lendsMoreMoney         Wether this bank lends more money to the user
+        */
+       public abstract function ifBankLendsMoreMoney ();
+
+       /**
+        * Checks wethert the current user has maximum allowed credits with this bank
+        *
+        * @return      $hasMaximumCredits      Wether the user has maximum allowed credits
+        */
+       public abstract function ifUserHasMaxCredits ();
+
+       /**
+        * Checks wether this money bank has opened
+        *
+        * @return      $hasOpened      Wether this money bank has opened
+        */
+       public abstract function ifMoneyBankHasOpened ();
+}
+
+// [EOF]
+?>