Launcher scripts updated
[mailer.git] / inc / classes / main / commands / image / class_ImageCodeCaptchaCommand.php
1 <?php
2 /**
3  * A command for creating code CAPTCHAs
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 ImageCodeCaptchaCommand extends BaseCommand implements Commandable {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33         }
34
35         /**
36          * Creates an instance of this class
37          *
38          * @param       $resolverInstance       An instance of a command resolver class
39          * @return      $commandInstance        An instance a prepared command class
40          */
41         public final static function createImageCodeCaptchaCommand (CommandResolver $resolverInstance) {
42                 // Get new instance
43                 $commandInstance = new ImageCodeCaptchaCommand();
44
45                 // Set the application instance
46                 $commandInstance->setResolverInstance($resolverInstance);
47
48                 // Return the prepared instance
49                 return $commandInstance;
50         }
51
52         /**
53          * Executes the given command with given request and response objects
54          *
55          * @param       $requestInstance        An instance of a class with an Requestable interface
56          * @param       $responseInstance       An instance of a class with an Responseable interface
57          * @return      void
58          */
59         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
60                 // Get the decrypted string from request (previously created by a filter!)
61                 $decryptedCode = $requestInstance->getRequestElement('decrypted');
62
63                 // Get the application instance
64                 $appInstance = $this->getResolverInstance()->getApplicationInstance();
65
66                 // Prepare a template instance
67                 $templateInstance = $this->prepareTemplateInstance($appInstance);
68
69                 // Assign variable
70                 $templateInstance->assignVariable('decrypted_code', $decryptedCode);
71
72                 // Load the code (pardon, image...) template
73                 $templateInstance->loadCodeTemplate('code_captcha');
74
75                 // Compile the template
76                 $templateInstance->compileTemplate();
77
78                 // Compile all variables
79                 $templateInstance->compileVariables();
80
81                 // Transfer it to the response
82                 $templateInstance->transferToResponse($responseInstance);
83         }
84
85         /**
86          * Adds extra filters to the given controller instance
87          *
88          * @param       $controllerInstance             A controller instance
89          * @param       $requestInstance                An instance of a class with an Requestable interface
90          * @return      void
91          */
92         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
93                 // Extra filters here...
94         }
95 }
96
97 // [EOF]
98 ?>