3 namespace CoreFramework\Command\Captcha;
5 // Import framework stuff
6 use CoreFramework\Command\BaseCommand;
7 use CoreFramework\Request\Requestable;
8 use CoreFramework\Response\Responseable;
11 * A command for creating code CAPTCHAs
13 * @author Roland Haeder <webmaster@shipsimu.org>
15 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
16 * @license GNU GPL 3.0 or any newer version
17 * @link http://www.shipsimu.org
19 * This program is free software: you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation, either version 3 of the License, or
22 * (at your option) any later version.
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
32 class ImageCodeCaptchaCommand extends BaseCommand implements Commandable {
34 * Protected constructor
38 protected function __construct () {
39 // Call parent constructor
40 parent::__construct(__CLASS__);
44 * Creates an instance of this class
46 * @param $resolverInstance An instance of a command resolver class
47 * @return $commandInstance An instance a prepared command class
49 public static final function createImageCodeCaptchaCommand (CommandResolver $resolverInstance) {
51 $commandInstance = new ImageCodeCaptchaCommand();
53 // Set the application instance
54 $commandInstance->setResolverInstance($resolverInstance);
56 // Return the prepared instance
57 return $commandInstance;
61 * Executes the given command with given request and response objects
63 * @param $requestInstance An instance of a class with an Requestable interface
64 * @param $responseInstance An instance of a class with an Responseable interface
67 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
68 // Get the decrypted string from request (previously created by a filter!)
69 $decryptedCode = $requestInstance->getRequestElement('decrypted');
71 // Get the application instance
72 $applicationInstance = $this->getResolverInstance()->getApplicationInstance();
74 // Prepare a template instance
75 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
78 $templateInstance->assignVariable('decrypted_code', $decryptedCode);
80 // Load the code (pardon, image...) template
81 $templateInstance->loadCodeTemplate('code_captcha');
83 // Compile the template
84 $templateInstance->compileTemplate();
86 // Compile all variables
87 $templateInstance->compileVariables();
89 // Transfer it to the response
90 $templateInstance->transferToResponse($responseInstance);
94 * Adds extra filters to the given controller instance
96 * @param $controllerInstance A controller instance
97 * @param $requestInstance An instance of a class with an Requestable interface
100 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
101 // Extra filters here...