Renamed Registry -> GenericRegistry to make it clear that this registry does
[core.git] / framework / main / interfaces / application / class_ManageableApplication.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Manager;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
7 use Org\Mxchange\CoreFramework\Template\CompileableTemplate;
8
9 /**
10  * An interface for managing applications. This can be a lot. E.g.:
11  *
12  * - Un-/locking applications
13  * - Creating selectors for the selector-mode
14  * - Usage statistics
15  * - And many more...
16  *
17  * @author              Roland Haeder <webmaster@shipsimu.org>
18  * @version             0.0.0
19  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
20  * @license             GNU GPL 3.0 or any newer version
21  * @link                http://www.shipsimu.org
22  *
23  * This program is free software: you can redistribute it and/or modify
24  * it under the terms of the GNU General Public License as published by
25  * the Free Software Foundation, either version 3 of the License, or
26  * (at your option) any later version.
27  *
28  * This program is distributed in the hope that it will be useful,
29  * but WITHOUT ANY WARRANTY; without even the implied warranty of
30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
31  * GNU General Public License for more details.
32  *
33  * You should have received a copy of the GNU General Public License
34  * along with this program. If not, see <http://www.gnu.org/licenses/>.
35  */
36 interface ManageableApplication extends FrameworkInterface {
37         /**
38          * 1) Setups application data
39          *
40          * @return      void
41          */
42         function setupApplicationData ();
43
44         /**
45          * 2) Does initial stuff before starting the application
46          *
47          * @return      void
48          */
49         function initApplication ();
50
51         /**
52          * 3) Launches the application
53          *
54          * @return      void
55          */
56         function launchApplication ();
57
58         /**
59          * Handle the indexed array of fatal messages and puts them out in an
60          * acceptable fasion
61          *
62          * @param       $messageList    An array of fatal messages
63          * @return      void
64          */
65         function handleFatalMessages (array $messageList);
66
67         /**
68          * Builds the master template's name
69          *
70          * @return      $masterTemplateName             Name of the master template
71          */
72         function buildMasterTemplateName();
73
74         /**
75          * Assigns extra application-depending data
76          *
77          * @param       $templateInstance       An instance of a CompileableTemplate
78          * @return      void
79          * @todo        Nothing to add?
80          */
81         function assignExtraTemplateData (CompileableTemplate $templateInstance);
82
83 }