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