3 * An action class for the logout page
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class WebLoginLogoutAction extends BaseAction implements Commandable, Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
35 $this->setObjectDescription("Logout action");
37 // Generate unique key
38 $this->generateUniqueId();
42 * Creates an instance of this action
44 * @return $actionInstance An instance of this action class
46 public final static function createWebLoginLogoutAction () {
48 $actionInstance = new WebLoginLogoutAction();
50 // Return the instance
51 return $actionInstance;
55 * Executes the command with given request and response objects
57 * @param $requestInstance An instance of a class with an Requestable interface
58 * @param $responseInstance An instance of a class with an Responseable interface
61 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
62 // Shall we logout or display logout page or logout immediately?
63 if (($this->getConfigInstance()->readConfig('logout_immediate') == "Y") || ($requestInstance->isRequestElementSet('logout'))) {
64 // Get an auth instance for checking and updating the auth cookies
65 $authInstance = ObjectFactory::createObjectByConfiguredName('auth_method_class', array($responseInstance));
67 // Set request instance
68 $authInstance->setRequestInstance($requestInstance);
70 // Destroy the auth data
71 $authInstance->destroyAuthData();
73 // Redirect to "logout done" page
74 $responseInstance->redirectToConfiguredUrl('logout_done_url');
79 * Adds extra filters to the given controller instance
81 * @param $controllerInstance A controller instance
82 * @param $requestInstance An instance of a class with an Requestable interface
85 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {