framework/main/classes/filter/guest/class_UserNameIsGuestFilter.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Filter\User\Username;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Filter\BaseFilter;
   7 use Org\Mxchange\CoreFramework\Filter\Filterable;
   8 use Org\Mxchange\CoreFramework\Request\Requestable;
   9 use Org\Mxchange\CoreFramework\Response\Responseable;
  10
  11 /**
  12  * A filter for checking if username "guest" has been choosen as configured. If
  13  * so the password will be set to the configured password.
  14  *
  15  * @author              Roland Haeder <webmaster@shipsimu.org>
  16  * @version             0.0.0
  17  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  18  * @license             GNU GPL 3.0 or any newer version
  19  * @link                http://www.shipsimu.org
  20  *
  21  * This program is free software: you can redistribute it and/or modify
  22  * it under the terms of the GNU General Public License as published by
  23  * the Free Software Foundation, either version 3 of the License, or
  24  * (at your option) any later version.
  25  *
  26  * This program is distributed in the hope that it will be useful,
  27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  29  * GNU General Public License for more details.
  30  *
  31  * You should have received a copy of the GNU General Public License
  32  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  33  */
  34 class UserNameIsGuestFilter extends BaseFilter implements Filterable {
  35         /**
  36          * Protected constructor
  37          *
  38          * @return      void
  39          */
  40         protected function __construct () {
  41                 // Call parent constructor
  42                 parent::__construct(__CLASS__);
  43         }
  44
  45         /**
  46          * Creates an instance of this filter class
  47          *
  48          * @return      $filterInstance                 An instance of this filter class
  49          */
  50         public static final function createUserNameIsGuestFilter () {
  51                 // Get a new instance
  52                 $filterInstance = new UserNameIsGuestFilter();
  53
  54                 // Return the instance
  55                 return $filterInstance;
  56         }
  57
  58         /**
  59          * Executes the filter with given request and response objects
  60          *
  61          * @param       $requestInstance        An instance of a class with an Requestable interface
  62          * @param       $responseInstance       An instance of a class with an Responseable interface
  63          * @return      void
  64          */
  65         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  66                 // Get username from request
  67                 $userName = $requestInstance->getRequestElement('username');
  68
  69                 // Does the user name match the guest login?
  70                 if ($userName == $this->getConfigInstance()->getConfigEntry('guest_login_user')) {
  71                         // Then set the password to the configured password
  72                         $requestInstance->setRequestElement('pass1', $this->getConfigInstance()->getConfigEntry('guest_login_passwd'));
  73                         $requestInstance->setRequestElement('pass2', $this->getConfigInstance()->getConfigEntry('guest_login_passwd'));
  74                 } // END - if
  75         }
  76
  77 }