2617c9e09eefc9dbad5a92205151ae80c02b3264
[core.git] / inc / main / classes / actions / html / class_HtmlLoginProfileAction.php
1 <?php
2 // Own namespace
3 namespace CoreFramework\Action\Login;
4
5 // Import framework stuff
6 use CoreFramework\Factory\ObjectFactory;
7 use CoreFramework\Registry\Registerable;
8 use CoreFramework\Request\Requestable;
9
10 /**
11  * An action for the profile page in login area
12  *
13  * @author              Roland Haeder <webmaster@shipsimu.org>
14  * @version             0.0.0
15  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
16  * @license             GNU GPL 3.0 or any newer version
17  * @link                http://www.shipsimu.org
18  *
19  * This program is free software: you can redistribute it and/or modify
20  * it under the terms of the GNU General Public License as published by
21  * the Free Software Foundation, either version 3 of the License, or
22  * (at your option) any later version.
23  *
24  * This program is distributed in the hope that it will be useful,
25  * but WITHOUT ANY WARRANTY; without even the implied warranty of
26  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
27  * GNU General Public License for more details.
28  *
29  * You should have received a copy of the GNU General Public License
30  * along with this program. If not, see <http://www.gnu.org/licenses/>.
31  */
32 class HtmlLoginProfileAction extends BaseAction implements Commandable, Registerable {
33         /**
34          * Protected constructor
35          *
36          * @return      void
37          */
38         protected function __construct () {
39                 // Call parent constructor
40                 parent::__construct(__CLASS__);
41         }
42
43         /**
44          * Creates an instance of this action
45          *
46          * @param       $resolverInstance       An instance of an action resolver
47          * @return      $actionInstance         An instance of this action class
48          */
49         public static final function createHtmlLoginProfileAction (ActionResolver $resolverInstance) {
50                 // Get a new instance
51                 $actionInstance = new HtmlLoginProfileAction();
52
53                 // Set the resolver instance
54                 $actionInstance->setResolverInstance($resolverInstance);
55
56                 // Return the instance
57                 return $actionInstance;
58         }
59
60         /**
61          * Executes the command with given request and response objects
62          *
63          * @param       $requestInstance        An instance of a class with an Requestable interface
64          * @param       $responseInstance       An instance of a class with an Responseable interface
65          * @return      void
66          */
67         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
68                 // Dummy method
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 status filter here
80                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_status_filter'));
81         }
82
83 }