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.
6 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
25 class UserNameIsGuestFilter extends BaseFilter implements Filterable {
27 * Protected constructor
31 protected function __construct () {
32 // Call parent constructor
33 parent::__construct(__CLASS__);
37 * Creates an instance of this filter class
39 * @return $filterInstance An instance of this filter class
41 public final static function createUserNameIsGuestFilter () {
43 $filterInstance = new UserNameIsGuestFilter();
45 // Return the instance
46 return $filterInstance;
50 * Executes the filter with given request and response objects
52 * @param $requestInstance An instance of a class with an Requestable interface
53 * @param $responseInstance An instance of a class with an Responseable interface
56 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
57 // Get username from request
58 $userName = $requestInstance->getRequestElement('username');
60 // Does the user name match the guest login?
61 if ($userName == $this->getConfigInstance()->readConfig('guest_login_user')) {
62 // Then set the password to the configured password
63 $requestInstance->setRequestElement('pass1', $this->getConfigInstance()->readConfig('guest_login_passwd'));
64 $requestInstance->setRequestElement('pass2', $this->getConfigInstance()->readConfig('guest_login_passwd'));