inc/main/interfaces/application/class_ManageableApplication.php

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