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