ef36945cc149e092ac9d0dd9076da4cb7f1d3ee0
[core.git] / framework / main / classes / commands / image / class_ImageCodeCaptchaCommand.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Command\Captcha;
4
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\Registry\Registry;
10 use Org\Mxchange\CoreFramework\Request\Requestable;
11 use Org\Mxchange\CoreFramework\Resolver\Command\CommandResolver;
12 use Org\Mxchange\CoreFramework\Response\Responseable;
13
14 /**
15  * A command for creating code CAPTCHAs
16  *
17  * @author              Roland Haeder <webmaster@shipsimu.org>
18  * @version             0.0.0
19 <<<<<<< HEAD:framework/main/classes/commands/image/class_ImageCodeCaptchaCommand.php
20  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
21 =======
22  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
23 >>>>>>> Some updates::inc/main/classes/commands/image/class_ImageCodeCaptchaCommand.php
24  * @license             GNU GPL 3.0 or any newer version
25  * @link                http://www.shipsimu.org
26  *
27  * This program is free software: you can redistribute it and/or modify
28  * it under the terms of the GNU General Public License as published by
29  * the Free Software Foundation, either version 3 of the License, or
30  * (at your option) any later version.
31  *
32  * This program is distributed in the hope that it will be useful,
33  * but WITHOUT ANY WARRANTY; without even the implied warranty of
34  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
35  * GNU General Public License for more details.
36  *
37  * You should have received a copy of the GNU General Public License
38  * along with this program. If not, see <http://www.gnu.org/licenses/>.
39  */
40 class ImageCodeCaptchaCommand extends BaseCommand implements Commandable {
41         /**
42          * Protected constructor
43          *
44          * @return      void
45          */
46         protected function __construct () {
47                 // Call parent constructor
48                 parent::__construct(__CLASS__);
49         }
50
51         /**
52          * Creates an instance of this class
53          *
54          * @param       $resolverInstance       An instance of a command resolver class
55          * @return      $commandInstance        An instance a prepared command class
56          */
57         public static final function createImageCodeCaptchaCommand (CommandResolver $resolverInstance) {
58                 // Get new instance
59                 $commandInstance = new ImageCodeCaptchaCommand();
60
61                 // Set the application instance
62                 $commandInstance->setResolverInstance($resolverInstance);
63
64                 // Return the prepared instance
65                 return $commandInstance;
66         }
67
68         /**
69          * Executes the given command with given request and response objects
70          *
71          * @param       $requestInstance        An instance of a class with an Requestable interface
72          * @param       $responseInstance       An instance of a class with an Responseable interface
73          * @return      void
74          */
75         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
76                 // Get the decrypted string from request (previously created by a filter!)
77                 $decryptedCode = $requestInstance->getRequestElement('decrypted');
78
79                 // Get the application instance
80                 $applicationInstance = Registry::getRegistry()->getInstance('app');
81
82                 // Prepare a template instance
83                 $templateInstance = $this->prepareTemplateInstance($applicationInstance);
84
85                 // Assign variable
86                 $templateInstance->assignVariable('decrypted_code', $decryptedCode);
87
88                 // Load the code (pardon, image...) template
89                 $templateInstance->loadCodeTemplate('code_captcha');
90
91                 // Compile the template
92                 $templateInstance->compileTemplate();
93
94                 // Compile all variables
95                 $templateInstance->compileVariables();
96
97                 // Transfer it to the response
98                 $templateInstance->transferToResponse($responseInstance);
99         }
100
101         /**
102          * Adds extra filters to the given controller instance
103          *
104          * @param       $controllerInstance             A controller instance
105          * @param       $requestInstance                An instance of a class with an Requestable interface
106          * @return      void
107          */
108         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
109                 // Extra filters here...
110         }
111
112 }