application/shipsimu/main/bank/class_BaseBank.php

   1 <?php
   2 /**
   3  * A general bank class
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Ship-Simu Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  * @todo                Find an instance for all banks and move the abstract functions there
  11  *
  12  * This program is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation, either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  24  */
  25 abstract class BaseBank extends BaseFrameworkSystem {
  26         /**
  27          * Protected constructor
  28          *
  29          * @param       $className      The class' real name
  30          * @return      void
  31          */
  32         protected function __construct ($className) {
  33                 // Call parent constructor
  34                 parent::__construct($className);
  35         }
  36
  37         /**
  38          * Checks wether the bank lends more money to the current user
  39          *
  40          * @return      $lendsMoreMoney         Wether this bank lends more money to the user
  41          */
  42         public abstract function ifBankLendsMoreMoney ();
  43
  44         /**
  45          * Checks wethert the current user has maximum allowed credits with this bank
  46          *
  47          * @return      $hasMaximumCredits      Wether the user has maximum allowed credits
  48          */
  49         public abstract function ifUserHasMaxCredits ();
  50
  51         /**
  52          * Checks wether this money bank has opened
  53          *
  54          * @return      $hasOpened      Wether this money bank has opened
  55          */
  56         public abstract function ifMoneyBankHasOpened ();
  57 }
  58
  59 // [EOF]
  60 ?>