Added new FrameworkFeature class + missing exception:
[core.git] / inc / classes / main / feature / class_
1 <?php
2 /**
3  * A ??? Feature class
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.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 class ???Feature extends BaseFeature implements Feature {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33         }
34
35         /**
36          * Creates an instance of this Feature class and prepares it for usage
37          *
38          * @param       $appInstance            A manageable application
39          * @return      $featureInstance        An instance of this Feature class
40          */
41         public final static function create???Feature (ManageableApplication $appInstance) {
42                 // Get a new instance
43                 $featureInstance = new ???Feature();
44
45                 // Return the prepared instance
46                 return $featureInstance;
47         }
48
49         /**
50          * Checks whether this feature can be made available to other classes.
51          *
52          * @return      $isAvailable    Whether this feature is available
53          * @todo        0% done
54          */
55         public function isFeatureAvailable () {
56                 // Default is not available
57                 $isAvailable = FALSE;
58
59                 // Unfinished:
60                 $this->partialSub('Please implement this method.');
61
62                 // Return status
63                 return $isAvailable;
64         }
65 }
66
67 // [EOF]
68 ?>