inc/classes/main/commands/image/class_ImageCodeCaptchaCommand.php

   1 <?php
   2 /**
   3  * A command for creating code CAPTCHAs
   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 ImageCodeCaptchaCommand 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("");
  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 createImageCodeCaptchaCommand (CommandResolver $resolverInstance) {
  51                 // Get new instance
  52                 $commandInstance = new ImageCodeCaptchaCommand();
  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 decrypted string from request (previously created by a filter!)
  70                 $decryptedCode = $requestInstance->getRequestElement('decrypted');
  71
  72                 // Get the application instance
  73                 $appInstance = $this->getResolverInstance()->getApplicationInstance();
  74
  75                 // Prepare a template instance
  76                 $templateInstance = $this->prepareTemplateEngine($appInstance);
  77
  78                 // Assign variable
  79                 $templateInstance->assignVariable('decrypted_code', $decryptedCode);
  80
  81                 // Load the code (pardon, image...) template
  82                 $templateInstance->loadCodeTemplate('code_captcha');
  83
  84                 // Compile the template
  85                 $templateInstance->compileTemplate();
  86
  87                 // Compile all variables
  88                 $templateInstance->compileVariables();
  89
  90                 // Transfer it to the response
  91                 $templateInstance->transferToResponse($responseInstance);
  92         }
  93
  94         /**
  95          * Adds extra filters to the given controller instance
  96          *
  97          * @param       $controllerInstance             A controller instance
  98          * @param       $requestInstance                An instance of a class with an Requestable interface
  99          * @return      void
 100          */
 101         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
 102                 // Extra filters here...
 103         }
 104 }
 105
 106 // [EOF]
 107 ?>