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

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