Copyright updated, menu class added for 'home'
[shipsimu.git] / application / ship-simu / main / commands / web / class_WebShipsimuRefillCommand.php
1 <?php
2 /**
3  * A command for the money refill page
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Ship-Simu Developer Team
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 WebShipsimuRefillCommand 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                 // Clean up a little
35                 $this->removeNumberFormaters();
36                 $this->removeSystemArray();
37         }
38
39         /**
40          * Creates an instance of this command and sets the resolver instance
41          *
42          * @param       $resolverInstance       An instance of a command resolver
43          * @return      $commandInstance        The created command instance
44          */
45         public final static function createWebShipsimuRefillCommand (CommandResolver $resolverInstance) {
46                 // Get a new instance
47                 $commandInstance = new WebShipsimuRefillCommand();
48
49                 // Set the resolver instance
50                 $commandInstance->setResolverInstance($resolverInstance);
51
52                 // Return the prepared instance
53                 return $commandInstance;
54         }
55
56         /**
57          * Executes the command with given request and response objects
58          *
59          * @param       $requestInstance        An instance of a class with an Requestable interface
60          * @param       $responseInstance       An instance of a class with an Responseable interface
61          * @return      void
62          */
63         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
64                 // Get template instance
65                 $templateInstance = $responseInstance->getTemplateInstance();
66
67                 // Set amount and type as variables
68                 $templateInstance->assignVariable('refill_done', $requestInstance->getRequestElement('type'));
69                 $templateInstance->assignVariable('amount'     , $requestInstance->getRequestElement('amount'));
70
71                 // This method does currently redirect if all goes right
72                 $responseInstance->redirectToConfiguredUrl('refill_page_done');
73         }
74
75         /**
76          * Adds extra filters to the given controller instance
77          *
78          * @param       $controllerInstance             A controller instance
79          * @param       $requestInstance                An instance of a class with an Requestable interface
80          * @return      void
81          */
82         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
83                 // Add user auth filter (we don't need an update of the user here because it will be redirected)
84                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_auth_filter'));
85
86                 // Add user status filter here
87                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_status_filter'));
88
89                 // Is the refill page active?
90                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('refill_page_filter'));
91
92                 // Verify password
93                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('account_password_filter'));
94
95                 // Verify CAPTCHA code
96                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('captcha_refill_verifier_filter'));
97
98                 // Verify refill request
99                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('refill_request_validator_filter'));
100
101                 // Construct config entry for wether automatic payment from API or waiting for approval
102                 $paymentTypeConfig = sprintf("refill_request_%s_payment_type", $requestInstance->getRequestElement('type'));
103
104                 // Prepare a filter based on the requested type we shall refill
105                 $filterName = sprintf("refill_request_%s_%s_book_filter",
106                         $requestInstance->getRequestElement('type'),
107                         $this->getConfigInstance()->readConfig($paymentTypeConfig)
108                 );
109
110                 // Now, try to load that filter
111                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName($filterName));
112         }
113 }
114
115 // [EOF]
116 ?>