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

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Command\Captcha;
   4
   5 // Import framework stuff
   6 use CoreFramework\Request\Requestable;
   7 use CoreFramework\Response\Responseable;
   8
   9 /**
  10  * A command for creating code CAPTCHAs
  11  *
  12  * @author              Roland Haeder <webmaster@shipsimu.org>
  13  * @version             0.0.0
  14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  15  * @license             GNU GPL 3.0 or any newer version
  16  * @link                http://www.shipsimu.org
  17  *
  18  * This program is free software: you can redistribute it and/or modify
  19  * it under the terms of the GNU General Public License as published by
  20  * the Free Software Foundation, either version 3 of the License, or
  21  * (at your option) any later version.
  22  *
  23  * This program is distributed in the hope that it will be useful,
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  * GNU General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU General Public License
  29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  30  */
  31 class ImageCodeCaptchaCommand extends BaseCommand implements Commandable {
  32         /**
  33          * Protected constructor
  34          *
  35          * @return      void
  36          */
  37         protected function __construct () {
  38                 // Call parent constructor
  39                 parent::__construct(__CLASS__);
  40         }
  41
  42         /**
  43          * Creates an instance of this class
  44          *
  45          * @param       $resolverInstance       An instance of a command resolver class
  46          * @return      $commandInstance        An instance a prepared command class
  47          */
  48         public static final function createImageCodeCaptchaCommand (CommandResolver $resolverInstance) {
  49                 // Get new instance
  50                 $commandInstance = new ImageCodeCaptchaCommand();
  51
  52                 // Set the application instance
  53                 $commandInstance->setResolverInstance($resolverInstance);
  54
  55                 // Return the prepared instance
  56                 return $commandInstance;
  57         }
  58
  59         /**
  60          * Executes the given command with given request and response objects
  61          *
  62          * @param       $requestInstance        An instance of a class with an Requestable interface
  63          * @param       $responseInstance       An instance of a class with an Responseable interface
  64          * @return      void
  65          */
  66         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  67                 // Get the decrypted string from request (previously created by a filter!)
  68                 $decryptedCode = $requestInstance->getRequestElement('decrypted');
  69
  70                 // Get the application instance
  71                 $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
  72
  73                 // Prepare a template instance
  74                 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
  75
  76                 // Assign variable
  77                 $templateInstance->assignVariable('decrypted_code', $decryptedCode);
  78
  79                 // Load the code (pardon, image...) template
  80                 $templateInstance->loadCodeTemplate('code_captcha');
  81
  82                 // Compile the template
  83                 $templateInstance->compileTemplate();
  84
  85                 // Compile all variables
  86                 $templateInstance->compileVariables();
  87
  88                 // Transfer it to the response
  89                 $templateInstance->transferToResponse($responseInstance);
  90         }
  91
  92         /**
  93          * Adds extra filters to the given controller instance
  94          *
  95          * @param       $controllerInstance             A controller instance
  96          * @param       $requestInstance                An instance of a class with an Requestable interface
  97          * @return      void
  98          */
  99         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
 100                 // Extra filters here...
 101         }
 102
 103 }