framework/main/classes/controller/image/captcha/class_ImageCodeCaptchaController.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Controller\Image\Captcha;
   4
   5 // Import framework stuff
   6 use CoreFramework\Controller\BaseController;
   7 use CoreFramework\Controller\Controller;
   8 use CoreFramework\Factory\ObjectFactory;
   9 use CoreFramework\Request\Requestable;
  10 use CoreFramework\Resolver\Command\CommandResolver;
  11 use CoreFramework\Response\Responseable;
  12
  13 /**
  14  * A controller for a code-based CAPTCHA where the user has to repeat a shown code
  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 ImageCodeCaptchaController extends BaseController implements Controller {
  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      $controllerInstance             A prepared instance of this class
  51          */
  52         public static final function createImageCodeCaptchaController (CommandResolver $resolverInstance) {
  53                 // Create the instance
  54                 $controllerInstance = new ImageCodeCaptchaController();
  55
  56                 // Set the command resolver
  57                 $controllerInstance->setResolverInstance($resolverInstance);
  58
  59                 // Add filter for checking the "encrypt" string
  60                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('captcha_encrypt_validator_filter'));
  61
  62                 // Return the prepared instance
  63                 return $controllerInstance;
  64         }
  65
  66         /**
  67          * Handles the given request and response
  68          *
  69          * @param       $requestInstance        An instance of a Requestable class
  70          * @param       $responseInstance       An instance of a Responseable class
  71          * @return      void
  72          */
  73         public function handleRequest (Requestable $requestInstance, Responseable $responseInstance) {
  74                 // Generic pre-post command execution
  75                 $this->executeGenericPrePostCommand($requestInstance, $responseInstance);
  76         }
  77
  78 }