3 namespace Org\Mxchange\CoreFramework\Command\Captcha;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Command\BaseCommand;
7 use Org\Mxchange\CoreFramework\Command\Commandable;
8 use Org\Mxchange\CoreFramework\Controller\Controller;
9 use Org\Mxchange\CoreFramework\Helper\Application\ApplicationHelper;
10 use Org\Mxchange\CoreFramework\Registry\GenericRegistry;
11 use Org\Mxchange\CoreFramework\Request\Requestable;
12 use Org\Mxchange\CoreFramework\Resolver\Command\CommandResolver;
13 use Org\Mxchange\CoreFramework\Response\Responseable;
16 * A command for creating code CAPTCHAs
18 * @author Roland Haeder <webmaster@shipsimu.org>
20 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
21 * @license GNU GPL 3.0 or any newer version
22 * @link http://www.shipsimu.org
24 * This program is free software: you can redistribute it and/or modify
25 * it under the terms of the GNU General Public License as published by
26 * the Free Software Foundation, either version 3 of the License, or
27 * (at your option) any later version.
29 * This program is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU General Public License for more details.
34 * You should have received a copy of the GNU General Public License
35 * along with this program. If not, see <http://www.gnu.org/licenses/>.
37 class ImageCodeCaptchaCommand extends BaseCommand implements Commandable {
39 * Protected constructor
43 private function __construct () {
44 // Call parent constructor
45 parent::__construct(__CLASS__);
49 * Creates an instance of this class
51 * @param $resolverInstance An instance of a command resolver class
52 * @return $commandInstance An instance a prepared command class
54 public static final function createImageCodeCaptchaCommand (CommandResolver $resolverInstance) {
56 $commandInstance = new ImageCodeCaptchaCommand();
58 // Set the application instance
59 $commandInstance->setResolverInstance($resolverInstance);
61 // Return the prepared instance
62 return $commandInstance;
66 * Executes the given command with given request and response objects
68 * @param $requestInstance An instance of a class with an Requestable interface
69 * @param $responseInstance An instance of a class with an Responseable interface
72 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
73 // Get the decrypted string from request (previously created by a filter!)
74 $decryptedCode = $requestInstance->getRequestElement('decrypted');
76 // Get the application instance
77 $applicationInstance = ApplicationHelper::getSelfInstance();
80 $this->getTemplateInstance()->assignVariable('decrypted_code', $decryptedCode);
82 // Load the code (pardon, image...) template
83 $this->getTemplateInstance()->loadCodeTemplate('code_captcha');
85 // Compile the template
86 $this->getTemplateInstance()->compileTemplate();
88 // Compile all variables
89 $this->getTemplateInstance()->compileVariables();
91 // Transfer it to the response
92 $this->getTemplateInstance()->transferToResponse($responseInstance);
96 * Adds extra filters to the given controller instance
98 * @param $controllerInstance A controller instance
99 * @param $requestInstance An instance of a class with an Requestable interface
102 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
103 // Extra filters here...