inc/classes/main/commands/web/class_WebConfirmCommand.php

   1 <?php
   2 /**
   3  * A command for the confirmation link handling
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class WebConfirmCommand extends BaseCommand implements Commandable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set special description
  35                 $this->setObjectDescription("Command for confirmation link handling");
  36
  37                 // Create unique ID number
  38                 $this->generateUniqueId();
  39
  40                 // Clean up a little
  41                 $this->removeSystemArray();
  42         }
  43
  44         /**
  45          * Creates an instance of this class
  46          *
  47          * @param       $resolverInstance       An instance of a command resolver class
  48          * @return      $commandInstance        An instance a prepared command class
  49          */
  50         public final static function createWebConfirmCommand (CommandResolver $resolverInstance) {
  51                 // Get new instance
  52                 $commandInstance = new WebConfirmCommand();
  53
  54                 // Set the application instance
  55                 $commandInstance->setResolverInstance($resolverInstance);
  56
  57                 // Return the prepared instance
  58                 return $commandInstance;
  59         }
  60
  61         /**
  62          * Executes the given command with given request and response objects
  63          *
  64          * @param       $requestInstance        An instance of a class with an Requestable interface
  65          * @param       $responseInstance       An instance of a class with an Responseable interface
  66          * @return      void
  67          */
  68         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  69                 // Get the application instance
  70                 $appInstance = $this->getResolverInstance()->getApplicationInstance();
  71
  72                 // Prepare a template instance
  73                 $templateInstance = $this->prepareTemplateInstance($appInstance);
  74
  75                 // Assign application data with template engine
  76                 $templateInstance->assignApplicationData($appInstance);
  77
  78                 // Assign base URL
  79                 $templateInstance->assignConfigVariable('base_url');
  80
  81                 // Load the master template
  82                 $masterTemplate = $appInstance->getMasterTemplate();
  83
  84                 // Load header template
  85                 $templateInstance->loadCodeTemplate('header');
  86
  87                 // Compile and assign it with a variable
  88                 $templateInstance->compileTemplate();
  89                 $templateInstance->assignTemplateWithVariable('header', 'header');
  90
  91                 // Load footer template
  92                 $templateInstance->loadCodeTemplate('footer');
  93
  94                 // Compile and assign it with a variable
  95                 $templateInstance->compileTemplate();
  96                 $templateInstance->assignTemplateWithVariable('footer', 'footer');
  97
  98                 // Load the home template
  99                 $templateInstance->loadCodeTemplate('confirm_link');
 100
 101                 // Assign the home template with the master template as a content ... ;)
 102                 $templateInstance->assignTemplateWithVariable('confirm_link', 'content');
 103
 104                 // Load the master template
 105                 $templateInstance->loadCodeTemplate($masterTemplate);
 106
 107                 // Set title
 108                 $templateInstance->assignVariable('title', $this->getLanguageInstance()->getMessage('page_confirm_link_title'));
 109
 110                 // Get user instance
 111                 $userInstance = Registry::getRegistry()->getInstance('user');
 112
 113                 // Set username
 114                 $templateInstance->assignVariable('username', $userInstance->getField(UserDatabaseWrapper::DB_COLUMN_USERNAME));
 115
 116                 // ... and all variables. This should be merged together in a pattern
 117                 // to make things easier. A cache mechanism should be added between
 118                 // these two calls to cache compiled templates.
 119                 $templateInstance->compileVariables();
 120
 121                 // Get the content back from the template engine and put it in the response class
 122                 $templateInstance->transferToResponse($responseInstance);
 123         }
 124
 125         /**
 126          * Adds extra filters to the given controller instance
 127          *
 128          * @param       $controllerInstance             A controller instance
 129          * @param       $requestInstance                An instance of a class with an Requestable interface
 130          * @return      void
 131          */
 132         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
 133                 // Empty for now
 134         }
 135 }
 136
 137 // [EOF]
 138 ?>