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

   1 <?php
   2 /**
   3  * A controller for a code-based CAPTCHA where the user has to repeat a shown code
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class ImageCodeCaptchaController extends BaseController implements Controller {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set part description
  35                 $this->setObjectDescription("");
  36
  37                 // Create unique ID number
  38                 $this->generateUniqueId();
  39         }
  40
  41         /**
  42          * Creates an instance of this class
  43          *
  44          * @param       $resolverInstance               An instance of a command resolver class
  45          * @return      $controllerInstance             A prepared instance of this class
  46          */
  47         public final static function createImageCodeCaptchaController (CommandResolver $resolverInstance) {
  48                 // Create the instance
  49                 $controllerInstance = new ImageCodeCaptchaController();
  50
  51                 // Set the command resolver
  52                 $controllerInstance->setResolverInstance($resolverInstance);
  53
  54                 // Add filter for checking the "encrypt" string
  55                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('captcha_encrypt_validator_class'));
  56
  57                 // Return the prepared instance
  58                 return $controllerInstance;
  59         }
  60
  61         /**
  62          * Handles the given request and response
  63          *
  64          * @param       $requestInstance        An instance of a request class
  65          * @param       $responseInstance       An instance of a response class
  66          * @return      void
  67          */
  68         public function handleRequest (Requestable $requestInstance, Responseable $responseInstance) {
  69                 // Execute pre filters
  70                 $this->executePreFilters($requestInstance, $responseInstance);
  71
  72                 // Get the command instance
  73                 $commandInstance = $this->getResolverInstance()->resolveCommandByRequest($requestInstance);
  74
  75                 // This request was valid! :-D
  76                 $requestInstance->requestIsValid();
  77
  78                 // Execute the command
  79                 $commandInstance->execute($requestInstance, $responseInstance);
  80
  81                 // Execute post filters
  82                 $this->executePostFilters($requestInstance, $responseInstance);
  83
  84                 // Flush the response out
  85                 $responseInstance->flushBuffer();
  86         }
  87 }
  88
  89 // [EOF]
  90 ?>