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