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 <<<<<<< HEAD:framework/main/interfaces/application/class_ManageableApplication.php
  20  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  21 =======
  22  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
  23 >>>>>>> Some updates::inc/main/interfaces/application/class_ManageableApplication.php
  24  * @license             GNU GPL 3.0 or any newer version
  25  * @link                http://www.shipsimu.org
  26  *
  27  * This program is free software: you can redistribute it and/or modify
  28  * it under the terms of the GNU General Public License as published by
  29  * the Free Software Foundation, either version 3 of the License, or
  30  * (at your option) any later version.
  31  *
  32  * This program is distributed in the hope that it will be useful,
  33  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  34  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  35  * GNU General Public License for more details.
  36  *
  37  * You should have received a copy of the GNU General Public License
  38  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  39  */
  40 interface ManageableApplication extends FrameworkInterface {
  41         /**
  42          * 1) Setups application data
  43          *
  44          * @return      void
  45          */
  46         function setupApplicationData ();
  47
  48         /**
  49          * 2) Does initial stuff before starting the application
  50          *
  51          * @return      void
  52          */
  53         function initApplication ();
  54
  55         /**
  56          * 3) Launches the application
  57          *
  58          * @return      void
  59          */
  60         function launchApplication ();
  61
  62         /**
  63          * Handle the indexed array of fatal messages and puts them out in an
  64          * acceptable fasion
  65          *
  66          * @param       $messageList    An array of fatal messages
  67          * @return      void
  68          */
  69         function handleFatalMessages (array $messageList);
  70
  71         /**
  72          * Builds the master template's name
  73          *
  74          * @return      $masterTemplateName             Name of the master template
  75          */
  76         function buildMasterTemplateName();
  77
  78         /**
  79          * Assigns extra application-depending data
  80          *
  81          * @param       $templateInstance       An instance of a CompileableTemplate
  82          * @return      void
  83          * @todo        Nothing to add?
  84          */
  85         function assignExtraTemplateData (CompileableTemplate $templateInstance);
  86
  87 }