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 - 2023 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          * Getter for the version number
  39          *
  40          * @return      $appVersion     The application's version number
  41          */
  42         function getAppVersion ();
  43
  44         /**
  45          * Setter for the version number
  46          *
  47          * @param       $appVersion     The application's version number
  48          * @return      void
  49          */
  50         function setAppVersion (string $appVersion);
  51
  52         /**
  53          * Getter for human-readable name
  54          *
  55          * @return      $appName        The application's human-readable name
  56          */
  57         function getAppName ();
  58
  59         /**
  60          * Setter for human-readable name
  61          *
  62          * @param       $appName        The application's human-readable name
  63          * @return      void
  64          */
  65         function setAppName (string $appName);
  66
  67         /**
  68          * Getter for short uni*-like name
  69          *
  70          * @return      $shortName      The application's short uni*-like name
  71          */
  72         function getAppShortName ();
  73
  74         /**
  75          * Setter for short uni*-like name
  76          *
  77          * @param       $shortName      The application's short uni*-like name
  78          * @return      void
  79          */
  80         function setAppShortName (string $shortName);
  81
  82         /**
  83          * 1) Setups application data
  84          *
  85          * @return      void
  86          */
  87         function setupApplicationData ();
  88
  89         /**
  90          * 2) Does initial stuff before starting the application
  91          *
  92          * @return      void
  93          */
  94         function initApplication ();
  95
  96         /**
  97          * 3) Launches the application
  98          *
  99          * @return      void
 100          */
 101         function launchApplication ();
 102
 103         /**
 104          * Handle the indexed array of fatal messages and puts them out in an
 105          * acceptable fasion
 106          *
 107          * @param       $messageList    An array of fatal messages
 108          * @return      void
 109          */
 110         function handleFatalMessages (array $messageList);
 111
 112         /**
 113          * Builds the master template's name
 114          *
 115          * @return      $masterTemplateName             Name of the master template
 116          */
 117         function buildMasterTemplateName ();
 118
 119         /**
 120          * Assigns extra application-depending data
 121          *
 122          * @param       $templateInstance       An instance of a CompileableTemplate
 123          * @return      void
 124          * @todo        Nothing to add?
 125          */
 126         function assignExtraTemplateData (CompileableTemplate $templateInstance);
 127
 128 }