inc/main/classes/commands/html/class_HtmlConfirmCommand.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Command\Guest;
   4
   5 // Import framework stuff
   6 use CoreFramework\Factory\ObjectFactory;
   7 use CoreFramework\Generic\NullPointerException;
   8 use CoreFramework\Registry\Generic\Registry;
   9 use CoreFramework\Request\Requestable;
  10 use CoreFramework\Response\Responseable;
  11
  12 /**
  13  * A command for the confirmation link handling
  14  *
  15  * @author              Roland Haeder <webmaster@shipsimu.org>
  16  * @version             0.0.0
  17  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  18  * @license             GNU GPL 3.0 or any newer version
  19  * @link                http://www.shipsimu.org
  20  *
  21  * This program is free software: you can redistribute it and/or modify
  22  * it under the terms of the GNU General Public License as published by
  23  * the Free Software Foundation, either version 3 of the License, or
  24  * (at your option) any later version.
  25  *
  26  * This program is distributed in the hope that it will be useful,
  27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  29  * GNU General Public License for more details.
  30  *
  31  * You should have received a copy of the GNU General Public License
  32  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  33  */
  34 class HtmlConfirmCommand extends BaseCommand implements Commandable {
  35         /**
  36          * Protected constructor
  37          *
  38          * @return      void
  39          */
  40         protected function __construct () {
  41                 // Call parent constructor
  42                 parent::__construct(__CLASS__);
  43         }
  44
  45         /**
  46          * Creates an instance of this class
  47          *
  48          * @param       $resolverInstance       An instance of a command resolver class
  49          * @return      $commandInstance        An instance a prepared command class
  50          */
  51         public static final function createHtmlConfirmCommand (CommandResolver $resolverInstance) {
  52                 // Get new instance
  53                 $commandInstance = new HtmlConfirmCommand();
  54
  55                 // Set the application instance
  56                 $commandInstance->setResolverInstance($resolverInstance);
  57
  58                 // Return the prepared instance
  59                 return $commandInstance;
  60         }
  61
  62         /**
  63          * Executes the given command with given request and response objects
  64          *
  65          * @param       $requestInstance        An instance of a class with an Requestable interface
  66          * @param       $responseInstance       An instance of a class with an Responseable interface
  67          * @return      void
  68          */
  69         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  70                 // Get the application instance
  71                 $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
  72
  73                 // Prepare a template instance
  74                 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
  75
  76                 // Assign application data with template engine
  77                 $templateInstance->assignApplicationData($applicationInstance);
  78
  79                 // Assign base URL
  80                 $templateInstance->assignConfigVariable('base_url');
  81
  82                 // Load the master template
  83                 $masterTemplate = $applicationInstance->buildMasterTemplateName();
  84
  85                 // Load header template
  86                 $templateInstance->loadCodeTemplate('header');
  87
  88                 // Compile and assign it with a variable
  89                 $templateInstance->compileTemplate();
  90                 $templateInstance->assignTemplateWithVariable('header', 'header');
  91
  92                 // Load footer template
  93                 $templateInstance->loadCodeTemplate('footer');
  94
  95                 // Compile and assign it with a variable
  96                 $templateInstance->compileTemplate();
  97                 $templateInstance->assignTemplateWithVariable('footer', 'footer');
  98
  99                 // Load the home template
 100                 $templateInstance->loadCodeTemplate('confirm_link');
 101
 102                 // Assign the home template with the master template as a content ... ;)
 103                 $templateInstance->assignTemplateWithVariable('confirm_link', 'main_content');
 104
 105                 // Load the master template
 106                 $templateInstance->loadCodeTemplate($masterTemplate);
 107
 108                 // Set title
 109                 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_confirm_link_title'));
 110
 111                 // Get user instance
 112                 try {
 113                         $userInstance = Registry::getRegistry()->getInstance('user');
 114                 } catch (NullPointerException $e) {
 115                         // Not found user, e.g. when the user is somehow invalid
 116                         $responseInstance->redirectToConfiguredUrl('html_cmd_user_is_null');
 117                 }
 118
 119                 // Set username
 120                 $templateInstance->assignVariable('username', $userInstance->getField(UserDatabaseWrapper::DB_COLUMN_USERNAME));
 121
 122                 // Construct the menu in every command. We could do this in BaseCommand class. But this means
 123                 // *every* command has a navigation system and that is want we don't want.
 124                 $menuInstance = ObjectFactory::createObjectByConfiguredName('confirm_menu_class', array($applicationInstance));
 125
 126                 // Render the menu
 127                 $menuInstance->renderMenu();
 128
 129                 // Transfer it to the template engine instance
 130                 $menuInstance->transferContentToTemplateEngine($templateInstance);
 131
 132                 /*
 133                  * ... and all variables. This should be merged together in a pattern
 134                  * to make things easier. A cache mechanism should be added between
 135                  * these two calls to cache compiled templates.
 136                  */
 137                 $templateInstance->compileVariables();
 138
 139                 // Get the content back from the template engine and put it in response class
 140                 $templateInstance->transferToResponse($responseInstance);
 141         }
 142
 143         /**
 144          * Adds extra filters to the given controller instance
 145          *
 146          * @param       $controllerInstance             A controller instance
 147          * @param       $requestInstance                An instance of a class with an Requestable interface
 148          * @return      void
 149          */
 150         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
 151                 // Empty for now
 152         }
 153
 154 }