application/tests/class_ApplicationHelper.php

   1 <?php
   2 // Must be this namespace, else the launcher cannot find the class.
   3 namespace Org\Mxchange\CoreFramework\Helper\Application;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Application\BaseApplication;
   7 use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
   8 use Org\Mxchange\CoreFramework\Factory\Object\ObjectFactory;
   9 use Org\Mxchange\CoreFramework\Loader\ClassLoader;
  10 use Org\Mxchange\CoreFramework\Manager\ManageableApplication;
  11 use Org\Mxchange\CoreFramework\Registry\Registerable;
  12 use Org\Mxchange\CoreFramework\Template\CompileableTemplate;
  13 use Org\Mxchange\CoreFramework\Utils\Strings\StringUtils;
  14
  15 /**
  16  * A class holding general data about the application and some methods for
  17  * the management including the entry point.
  18  *
  19  * E.g.:
  20  *
  21  * index.php?app=my_app
  22  *
  23  * You need to create a folder in the folder "application" named "my_app"
  24  * (without the quotes) and create a include file called
  25  * class_ApplicationHelper.php. You have to write the same class for your
  26  * application and implement the same interface called ManageableApplication
  27  * because this class include file will be searched for.
  28  *
  29  * It is good when you avoid more GET parameters to keep URLs short and sweet.
  30  * But sometimes you need some GET paramerers e.g. for your imprint or info page
  31  * or other linked pages which you have to create and state some informations.
  32  *
  33  * Please remember that this include file is being loaded *before* the class
  34  * loader is loading classes from "exceptions", "interfaces" and "main"!
  35  *
  36  * @author              Roland Haeder <webmaster@shipsimu.org>
  37  * @version             0.0
  38  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2022 Core Developer Team
  39  * @license             GNU GPL 3.0 or any newer version
  40  *
  41  * This program is free software: you can redistribute it and/or modify
  42  * it under the terms of the GNU General Public License as published by
  43  * the Free Software Foundation, either version 3 of the License, or
  44  * (at your option) any later version.
  45  *
  46  * This program is distributed in the hope that it will be useful,
  47  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  48  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  49  * GNU General Public License for more details.
  50  *
  51  * You should have received a copy of the GNU General Public License
  52  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  53  */
  54 class ApplicationHelper extends BaseApplication implements ManageableApplication, Registerable {
  55         /**
  56          * Private constructor
  57          *
  58          * @return      void
  59          */
  60         private function __construct () {
  61                 // Call parent constructor
  62                 parent::__construct(__CLASS__);
  63         }
  64
  65         /**
  66          * Getter for an instance of this class
  67          *
  68          * @return      $selfInstance   An instance of this class
  69          */
  70         public static final function getSelfInstance () {
  71                 // Is the instance there?
  72                 if (is_null(self::getApplicationInstance())) {
  73                         // Then set it
  74                         self::setApplicationInstance(new ApplicationHelper());
  75                 }
  76
  77                 // Return the instance
  78                 return self::getApplicationInstance();
  79         }
  80
  81         /**
  82          * 1) Setups application data
  83          *
  84          * @return      void
  85          */
  86         public function setupApplicationData () {
  87                 // Set all application data
  88                 $this->setAppName('Unit tests and more');
  89                 $this->setAppVersion('0.0.0');
  90                 $this->setAppShortName('tests');
  91         }
  92
  93         /**
  94          * 2) Does initial stuff before starting the application
  95          *
  96          * @return      void
  97          */
  98         public function initApplication () {
  99                 // Get config instance
 100                 $cfg = FrameworkBootstrap::getConfigurationInstance();
 101
 102                 // Initialize output system
 103                 self::createDebugInstance('ApplicationHelper');
 104
 105                 /*
 106                  * This application needs a database connection then simply call init
 107                  * method.
 108                  */
 109                 FrameworkBootstrap::initDatabaseInstance();
 110
 111                 // Register core tests
 112                 ClassLoader::registerTestsPath('framework/main/tests');
 113
 114                 // Register own tests
 115                 ClassLoader::registerTestsPath('application/tests/tests');
 116
 117                 // Scan for them now
 118                 ClassLoader::scanTestsClasses();
 119         }
 120
 121         /**
 122          * 3) Launches the application
 123          *
 124          * @return      void
 125          */
 126         public function launchApplication () {
 127                 // Get request/response instances
 128                 $requestInstance  = FrameworkBootstrap::getRequestInstance();
 129                 $responseInstance = FrameworkBootstrap::getResponseInstance();
 130
 131                 // Get the parameter from the request
 132                 $commandName = $requestInstance->getRequestElement('command');
 133
 134                 // If it is null then get default command
 135                 if (is_null($commandName)) {
 136                         // Get default command
 137                         $commandName = $responseInstance->determineDefaultCommand();
 138
 139                         // Set it in request
 140                         $requestInstance->setRequestElement('command', $commandName);
 141                 }
 142
 143                 // Configuration entry key
 144                 $configEntry = sprintf(
 145                         '%s_%s_controller_resolver_class',
 146                         $this->getAppShortName(),
 147                         FrameworkBootstrap::getRequestTypeFromSystem()
 148                 );
 149
 150                 // Get a controller resolver instance
 151                 $resolverInstance = ObjectFactory::createObjectByConfiguredName($configEntry, [
 152                         $commandName,
 153                 ]);
 154
 155                 // Get a controller instance as well
 156                 $this->setControllerInstance($resolverInstance->resolveController());
 157
 158                 // Launch the test suite here
 159                 $this->getControllerInstance()->handleRequest($requestInstance, $responseInstance);
 160
 161                 // -------------------------- Shutdown phase --------------------------
 162                 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('MAIN: Shutdown in progress ...');
 163                 $this->getControllerInstance()->executeShutdownFilters($requestInstance, $responseInstance);
 164                 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('MAIN: Shutdown completed. (This is the last line.)');
 165         }
 166
 167         /**
 168          * Handle the indexed array of fatal messages and puts them out in an
 169          * acceptable fasion
 170          *
 171          * @param       $messageList    An array of fatal messages
 172          * @return      void
 173          */
 174         public function handleFatalMessages (array $messageList) {
 175                 // Walk through all messages
 176                 foreach ($messageList as $message) {
 177                         exit(__METHOD__ . ':MSG:' . $message);
 178                 }
 179         }
 180
 181         /**
 182          * Builds the master template's name
 183          *
 184          * @return      $masterTemplateName             Name of the master template
 185          */
 186         public function buildMasterTemplateName () {
 187                 return 'tests_main';
 188         }
 189
 190         /**
 191          * Assigns extra application-depending data
 192          *
 193          * @param       $templateInstance       An instance of a CompileableTemplate class
 194          * @return      void
 195          * @todo        Nothing to add?
 196          */
 197         public function assignExtraTemplateData (CompileableTemplate $templateInstance) {
 198                 $this->partialStub('Unfinished method. templateInstance=' . $templateInstance->__toString());
 199         }
 200
 201 }