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\Object\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  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
  20  * @license             GNU GPL 3.0 or any newer version
  21  * @link                http://www.shipsimu.org
  22  *
  23  * This program is free software: you can redistribute it and/or modify
  24  * it under the terms of the GNU General Public License as published by
  25  * the Free Software Foundation, either version 3 of the License, or
  26  * (at your option) any later version.
  27  *
  28  * This program is distributed in the hope that it will be useful,
  29  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  31  * GNU General Public License for more details.
  32  *
  33  * You should have received a copy of the GNU General Public License
  34  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  35  */
  36 class HtmlLoginProfileAction extends BaseAction implements PerformableAction, Registerable {
  37         /**
  38          * Protected constructor
  39          *
  40          * @return      void
  41          */
  42         private function __construct () {
  43                 // Call parent constructor
  44                 parent::__construct(__CLASS__);
  45         }
  46
  47         /**
  48          * Creates an instance of this action
  49          *
  50          * @param       $resolverInstance       An instance of an action resolver
  51          * @return      $actionInstance         An instance of this action class
  52          */
  53         public static final function createHtmlLoginProfileAction (ActionResolver $resolverInstance) {
  54                 // Get a new instance
  55                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('HTML-LOGIN-PROFILE-ACTION: resolverInstance=%s - CALLED!', $resolverInstance->__toString()));
  56                 $actionInstance = new HtmlLoginProfileAction();
  57
  58                 // Set the resolver instance
  59                 $actionInstance->setResolverInstance($resolverInstance);
  60
  61                 // Return the instance
  62                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('HTML-LOGIN-PROFILE-ACTION: actionInstance=%s - EXIT!', $actionInstance->__toString()));
  63                 return $actionInstance;
  64         }
  65
  66         /**
  67          * Executes the action with given request and response objects
  68          *
  69          * @param       $requestInstance        An instance of a class with an Requestable interface
  70          * @param       $responseInstance       An instance of a class with an Responseable interface
  71          * @return      void
  72          */
  73         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  74                 // Dummy method
  75                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('HTML-LOGIN-PROFILE-ACTION: requestInstance=%s,responseInstance=%s - CALLED!', $requestInstance->__toString(), $responseInstance->__toString()));
  76         }
  77
  78         /**
  79          * Adds extra filters to the given controller instance
  80          *
  81          * @param       $controllerInstance             A controller instance
  82          * @param       $requestInstance                An instance of a class with an Requestable interface
  83          * @return      void
  84          */
  85         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
  86                 // Add user status filter here
  87                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage(sprintf('HTML-LOGIN-PROFILE-ACTION: controllerInstance=%s,requestInstance=%s - CALLED!', $controllerInstance->__toString(), $requestInstance->__toString()));
  88                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_status_filter_class'));
  89
  90                 // Trace message
  91                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->traceMessage('HTML-LOGIN-PROFILE-ACTION: EXIT!');
  92         }
  93
  94 }