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

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Controller\Image\Captcha;
   4
   5 /**
   6  * A controller for a code-based CAPTCHA where the user has to repeat a shown code
   7  *
   8  * @author              Roland Haeder <webmaster@shipsimu.org>
   9  * @version             0.0.0
  10  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  11  * @license             GNU GPL 3.0 or any newer version
  12  * @link                http://www.shipsimu.org
  13  *
  14  * This program is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation, either version 3 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  26  */
  27 class ImageCodeCaptchaController extends BaseController implements Controller {
  28         /**
  29          * Protected constructor
  30          *
  31          * @return      void
  32          */
  33         protected function __construct () {
  34                 // Call parent constructor
  35                 parent::__construct(__CLASS__);
  36         }
  37
  38         /**
  39          * Creates an instance of this class
  40          *
  41          * @param       $resolverInstance               An instance of a command resolver class
  42          * @return      $controllerInstance             A prepared instance of this class
  43          */
  44         public static final function createImageCodeCaptchaController (CommandResolver $resolverInstance) {
  45                 // Create the instance
  46                 $controllerInstance = new ImageCodeCaptchaController();
  47
  48                 // Set the command resolver
  49                 $controllerInstance->setResolverInstance($resolverInstance);
  50
  51                 // Add filter for checking the "encrypt" string
  52                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('captcha_encrypt_validator_filter'));
  53
  54                 // Return the prepared instance
  55                 return $controllerInstance;
  56         }
  57
  58         /**
  59          * Handles the given request and response
  60          *
  61          * @param       $requestInstance        An instance of a request class
  62          * @param       $responseInstance       An instance of a response class
  63          * @return      void
  64          */
  65         public function handleRequest (Requestable $requestInstance, Responseable $responseInstance) {
  66                 // Generic pre-post command execution
  67                 $this->executeGenericPrePostCommand($requestInstance, $responseInstance);
  68         }
  69
  70 }