framework/main/classes/commands/class_BaseCommand.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Command;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
   7 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
   8 use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
   9 use Org\Mxchange\CoreFramework\Request\Requestable;
  10 use Org\Mxchange\CoreFramework\Resolver\Resolver;
  11 use Org\Mxchange\CoreFramework\Response\Responseable;
  12
  13 /**
  14  * A general (base) command
  15  *
  16  * @author              Roland Haeder <webmaster@shipsimu.org>
  17  * @version             0.0.0
  18  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 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 abstract class BaseCommand extends BaseFrameworkSystem {
  36         /**
  37          * Resolver instance
  38          */
  39         private $resolverInstance = NULL;
  40
  41         /**
  42          * Protected constructor
  43          *
  44          * @param       $className      Name of the class
  45          * @return      void
  46          */
  47         protected function __construct (string $className) {
  48                 // Call parent constructor
  49                 parent::__construct($className);
  50         }
  51
  52         /**
  53          * Initializes the template engine
  54          *
  55          * @param       $templateType   Type of template, e.g. 'html', 'image', 'console' ...
  56          * @return      void
  57          */
  58         public final function initTemplateEngine (string $templateType) {
  59                 // Prepare a template instance
  60                 $templateInstance = ObjectFactory::createObjectByConfiguredName(sprintf('%s_template_class', $templateType));
  61
  62                 // Set it here
  63                 $this->setTemplateInstance($templateInstance);
  64         }
  65
  66         /**
  67          * Setter for resolver instance
  68          *
  69          * @param       $resolverInstance       Instance of a command resolver class
  70          * @return      void
  71          */
  72         protected final function setResolverInstance (Resolver $resolverInstance) {
  73                 $this->resolverInstance = $resolverInstance;
  74         }
  75
  76         /**
  77          * Getter for resolver instance
  78          *
  79          * @return      $resolverInstance       Instance of a command resolver class
  80          */
  81         protected final function getResolverInstance () {
  82                 return $this->resolverInstance;
  83         }
  84
  85         /**
  86          * Sends a generic HTTP response with header, menu, content and footer
  87          *
  88          * @param       $requestInstance        An instance of a class with an Requestable interface
  89          * @param       $responseInstance       An instance of a class with an Responseable interface
  90          * @param       $suffix                         Optional template suffix, e.g. '_form' for forms
  91          * @return      void
  92          */
  93         protected function sendGenericGetResponse (Requestable $requestInstance, Responseable $responseInstance, string $suffix = '') {
  94                 // This command doesn't handle any POST requests, so only handle get request
  95                 assert(!$requestInstance->isPostRequestMethod());
  96
  97                 // Get the application instance
  98                 $applicationInstance = GenericRegistry::getRegistry()->getInstance('application');
  99
 100                 // Transfer application data
 101                 $this->getTemplateInstance()->assignApplicationData();
 102
 103                 // Assign base URL
 104                 $this->getTemplateInstance()->assignConfigVariable('base_url');
 105
 106                 // Load the master template
 107                 $masterTemplate = $applicationInstance->buildMasterTemplateName();
 108
 109                 // Load header template
 110                 $this->getTemplateInstance()->loadCodeTemplate('header');
 111
 112                 // Compile and assign it with a variable
 113                 $this->getTemplateInstance()->compileTemplate();
 114                 $this->getTemplateInstance()->assignTemplateWithVariable('header', 'header');
 115
 116                 // Load footer template
 117                 $this->getTemplateInstance()->loadCodeTemplate('footer');
 118
 119                 // Compile and assign it with a variable
 120                 $this->getTemplateInstance()->compileTemplate();
 121                 $this->getTemplateInstance()->assignTemplateWithVariable('footer', 'footer');
 122
 123                 // Load the content template
 124                 $this->getTemplateInstance()->loadCodeTemplate($this->getResolverInstance()->getCommandName() . $suffix);
 125
 126                 // Assign the content template with the master template as a content ... ;)
 127                 $this->getTemplateInstance()->assignTemplateWithVariable($applicationInstance->getAppShortName() . '_' . $this->getResolverInstance()->getCommandName(), 'main_content');
 128
 129                 // Load the master template
 130                 $this->getTemplateInstance()->loadCodeTemplate($masterTemplate);
 131
 132                 // Set title
 133                 $this->getTemplateInstance()->assignVariable('title', $this->getLanguageInstance()->getMessage('page_' . $applicationInstance->getAppShortName() . '_' . $this->getResolverInstance()->getCommandName() . '_title'));
 134
 135                 // Construct the menu in every command. We could do this in BaseCommand class. But this means
 136                 // *every* command has a navigation system and that is want we don't want.
 137                 $menuInstance = ObjectFactory::createObjectByConfiguredName($applicationInstance->getAppShortName() . '_' . $this->getResolverInstance()->getCommandName() . '_menu_class', array($applicationInstance));
 138
 139                 // Render the menu
 140                 $menuInstance->renderMenu();
 141
 142                 // Transfer it to the template engine instance
 143                 $menuInstance->transferContentToTemplateEngine($this->getTemplateInstance());
 144
 145                 /*
 146                  * ... and all variables. This should be merged together in a pattern
 147                  * to make things easier. A cache mechanism should be added between
 148                  * these two calls to cache compiled templates.
 149                  */
 150                 $this->getTemplateInstance()->compileVariables();
 151
 152                 // Get the content back from the template engine and put it in response class
 153                 $this->getTemplateInstance()->transferToResponse($responseInstance);
 154         }
 155
 156 }