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

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