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