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