3 * A command for creating code CAPTCHAs
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
24 class ImageCodeCaptchaCommand extends BaseCommand implements Commandable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
34 // Set special description
35 $this->setObjectDescription("");
37 // Create unique ID number
38 $this->generateUniqueId();
41 $this->removeSystemArray();
45 * Creates an instance of this class
47 * @param $resolverInstance An instance of a command resolver class
48 * @return $commandInstance An instance a prepared command class
50 public final static function createImageCodeCaptchaCommand (CommandResolver $resolverInstance) {
52 $commandInstance = new ImageCodeCaptchaCommand();
54 // Set the application instance
55 $commandInstance->setResolverInstance($resolverInstance);
57 // Return the prepared instance
58 return $commandInstance;
62 * Executes the given command with given request and response objects
64 * @param $requestInstance An instance of a class with an Requestable interface
65 * @param $responseInstance An instance of a class with an Responseable interface
68 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
69 // Get the decrypted string from request (previously created by a filter!)
70 $decryptedCode = $requestInstance->getRequestElement('decrypted');
72 // Get the application instance
73 $appInstance = $this->getResolverInstance()->getApplicationInstance();
75 // Prepare a template instance
76 $templateInstance = $this->prepareTemplateInstance($appInstance);
79 $templateInstance->assignVariable('decrypted_code', $decryptedCode);
81 // Load the code (pardon, image...) template
82 $templateInstance->loadCodeTemplate('code_captcha');
84 // Compile the template
85 $templateInstance->compileTemplate();
87 // Compile all variables
88 $templateInstance->compileVariables();
90 // Transfer it to the response
91 $templateInstance->transferToResponse($responseInstance);
95 * Adds extra filters to the given controller instance
97 * @param $controllerInstance A controller instance
98 * @param $requestInstance An instance of a class with an Requestable interface
101 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
102 // Extra filters here...