application/city/classes/commands/html/class_CityHtmlConfirmCommand.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\Command;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Command\BaseCommand;
   7 use Org\Mxchange\CoreFramework\Command\Commandable;
   8 use Org\Mxchange\CoreFramework\Controller\Controller;
   9 use Org\Mxchange\CoreFramework\Registry\Registry;
  10 use Org\Mxchange\CoreFramework\Request\Requestable;
  11 use Org\Mxchange\CoreFramework\Resolver\Command\CommandResolver;
  12 use Org\Mxchange\CoreFramework\Response\Responseable;
  13
  14 /**
  15  * A command for the confirmation link handling
  16  *
  17  * @author              Roland Haeder <webmaster@shipsimu.org>
  18  * @version             0.0.0
  19  * @copyright   Copyright (c) 2015, 2016 City 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 class CityHtmlConfirmCommand extends BaseCommand implements Commandable {
  37         /**
  38          * Protected constructor
  39          *
  40          * @return      void
  41          */
  42         protected function __construct () {
  43                 // Call parent constructor
  44                 parent::__construct(__CLASS__);
  45         }
  46
  47         /**
  48          * Creates an instance of this class
  49          *
  50          * @param       $resolverInstance       An instance of a command resolver class
  51          * @return      $commandInstance        An instance a prepared command class
  52          */
  53         public static final function createCityHtmlConfirmCommand (CommandResolver $resolverInstance) {
  54                 // Get new instance
  55                 $commandInstance = new CityHtmlConfirmCommand();
  56
  57                 // Set the application instance
  58                 $commandInstance->setResolverInstance($resolverInstance);
  59
  60                 // Return the prepared instance
  61                 return $commandInstance;
  62         }
  63
  64         /**
  65          * Executes the given command with given request and response objects
  66          *
  67          * @param       $requestInstance        An instance of a class with an Requestable interface
  68          * @param       $responseInstance       An instance of a class with an Responseable interface
  69          * @return      void
  70          */
  71         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  72                 // Get the application instance
  73                 $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
  74
  75                 // Prepare a template instance
  76                 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
  77
  78                 // Assign application data with template engine
  79                 $templateInstance->assignApplicationData($applicationInstance);
  80
  81                 // Assign base URL
  82                 $templateInstance->assignConfigVariable('base_url');
  83
  84                 // Load the master template
  85                 $masterTemplate = $applicationInstance->buildMasterTemplateName();
  86
  87                 // Load header template
  88                 $templateInstance->loadCodeTemplate('header');
  89
  90                 // Compile and assign it with a variable
  91                 $templateInstance->compileTemplate();
  92                 $templateInstance->assignTemplateWithVariable('header', 'header');
  93
  94                 // Load footer template
  95                 $templateInstance->loadCodeTemplate('footer');
  96
  97                 // Compile and assign it with a variable
  98                 $templateInstance->compileTemplate();
  99                 $templateInstance->assignTemplateWithVariable('footer', 'footer');
 100
 101                 // Load the home template
 102                 $templateInstance->loadCodeTemplate('confirm_link');
 103
 104                 // Assign the home template with the master template as a content ... ;)
 105                 $templateInstance->assignTemplateWithVariable('confirm_link', 'main_content');
 106
 107                 // Load the master template
 108                 $templateInstance->loadCodeTemplate($masterTemplate);
 109
 110                 // Set title
 111                 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_confirm_link_title'));
 112
 113                 // Get user instance
 114                 try {
 115                         $userInstance = Registry::getRegistry()->getInstance('user');
 116                 } catch (NullPointerException $e) {
 117                         // Not found user, e.g. when the user is somehow invalid
 118                         $responseInstance->redirectToConfiguredUrl('html_cmd_user_is_null');
 119                 }
 120
 121                 // Set username
 122                 $templateInstance->assignVariable('username', $userInstance->getField(UserDatabaseWrapper::DB_COLUMN_USERNAME));
 123
 124                 // Construct the menu in every command. We could do this in BaseCommand class. But this means
 125                 // *every* command has a navigation system and that is want we don't want.
 126                 $menuInstance = ObjectFactory::createObjectByConfiguredName('confirm_menu_class', array($applicationInstance));
 127
 128                 // Render the menu
 129                 $menuInstance->renderMenu();
 130
 131                 // Transfer it to the template engine instance
 132                 $menuInstance->transferContentToTemplateEngine($templateInstance);
 133
 134                 /*
 135                  * ... and all variables. This should be merged together in a pattern
 136                  * to make things easier. A cache mechanism should be added between
 137                  * these two calls to cache compiled templates.
 138                  */
 139                 $templateInstance->compileVariables();
 140
 141                 // Get the content back from the template engine and put it in response class
 142                 $templateInstance->transferToResponse($responseInstance);
 143         }
 144
 145         /**
 146          * Adds extra filters to the given controller instance
 147          *
 148          * @param       $controllerInstance             A controller instance
 149          * @param       $requestInstance                An instance of a class with an Requestable interface
 150          * @return      void
 151          */
 152         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
 153                 // Empty for now
 154         }
 155 }