framework/main/classes/actions/html/class_HtmlLoginProfileAction.php

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