More renamed
[shipsimu.git] / application / ship-simu / main / opening / class_BaseOpening.php
1 <?php
2 /**
3  * A general opening time 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  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
23  */
24 abstract class BaseOpening extends BaseFrameworkSystem {
25         /**
26          * A bank instance
27          */
28         private $bankInstance = null;
29
30         /**
31          * Protected constructor
32          *
33          * @param       $className      The class' real name
34          * @return      void
35          */
36         protected function __construct ($className) {
37                 // Call parent constructor
38                 parent::__construct($className);
39         }
40
41         /**
42          * Setter for bank instance
43          *
44          * @param       $bankInstance   An instance of a bank
45          * @return      void
46          */
47         protected final function setBankInstance (BaseBank $bankInstance) {
48                 $this->bankInstance = $bankInstance;
49         }
50
51         /**
52          * Checks wether we are within the opening times
53          *
54          * @return      $withinOpeningTimes             Wether we are within opening times
55          */
56         public abstract function ifWithinOpeningTimes ();
57 }
58
59 // [EOF]
60 ?>