842d6cb9f343ce5c41667fbf1de9182fd4d96dc4
[shipsimu.git] / application / ship-simu / main / actions / web / class_WebShipSimuLoginCompanyAction.php
1 <?php
2 /**
3  * An action for shipping company 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 WebShipSimuLoginCompanyAction extends BaseShipSimuAction implements Commandable, Registerable {
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 action
37          *
38          * @param       $resolverInstance       An instance of an action resolver
39          * @return      $actionInstance         An instance of this action class
40          */
41         public static final function createWebShipSimuLoginCompanyAction (ActionResolver $resolverInstance) {
42                 // Get a new instance
43                 $actionInstance = new WebShipSimuLoginCompanyAction();
44
45                 // Set the resolver instance
46                 $actionInstance->setResolverInstance($resolverInstance);
47
48                 // Return the instance
49                 return $actionInstance;
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          * @todo        Maybe add fetching company list of current user here?
59          */
60         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
61                 // Call parent execute method
62                 parent::execute($requestInstance, $responseInstance);
63
64                 // Add your code here...
65         }
66
67         /**
68          * Adds extra filters to the given controller instance
69          *
70          * @param       $controllerInstance             A controller instance
71          * @param       $requestInstance                An instance of a class with an Requestable interface
72          * @return      void
73          * @todo        Add some more filters here
74          */
75         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
76                 // Check for user status by default
77                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_status_filter'));
78         }
79 }
80
81 // [EOF]
82 ?>