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

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