inc/classes/interfaces/application/class_ManageableApplication.php

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