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

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