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