More renamed
[shipsimu.git] / application / ship-simu / main / commands / web / company / class_WebShipSimuCompanyCommand.php
1 <?php
2 /**
3  * A command for the money refill page
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.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.shipsimu.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 WebShipSimuCompanyCommand 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 command and sets the resolver instance
37          *
38          * @param       $resolverInstance       An instance of a command resolver
39          * @return      $commandInstance        The created command instance
40          */
41         public static final function createWebShipSimuCompanyCommand (CommandResolver $resolverInstance) {
42                 // Get a new instance
43                 $commandInstance = new WebShipSimuCompanyCommand();
44
45                 // Set the resolver instance
46                 $commandInstance->setResolverInstance($resolverInstance);
47
48                 // Return the prepared instance
49                 return $commandInstance;
50         }
51
52         /**
53          * Executes the 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 template instance
61                 $templateInstance = $responseInstance->getTemplateInstance();
62
63                 // Set amount and type as variables
64                 $templateInstance->assignVariable('refill_done', $requestInstance->getRequestElement('type'));
65                 $templateInstance->assignVariable('amount'     , $requestInstance->getRequestElement('amount'));
66
67                 // This method does currently redirect if all goes right
68                 $responseInstance->redirectToConfiguredUrl('refill_page_done');
69         }
70
71         /**
72          * Adds extra filters to the given controller instance
73          *
74          * @param       $controllerInstance             A controller instance
75          * @param       $requestInstance                An instance of a class with an Requestable interface
76          * @return      void
77          */
78         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
79                 // Add user auth filter (we don't need an update of the user here because it will be redirected)
80                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_auth_filter'));
81
82                 // Add user status filter here
83                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_status_filter'));
84         }
85 }
86
87 // [EOF]
88 ?>