3 namespace Org\Mxchange\City\Action\Login;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Controller\Controller;
7 use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
8 use Org\Mxchange\CoreFramework\Request\Requestable;
9 use Org\Mxchange\CoreFramework\Response\Responseable;
12 * An action for logout
14 * @author Roland Haeder <webmaster@shipsimu.org>
16 * @copyright Copyright (c) 2015, 2016 City Developer Team
17 * @license GNU GPL 3.0 or any newer version
18 * @link http://www.shipsimu.org
20 * This program is free software: you can redistribute it and/or modify
21 * it under the terms of the GNU General Public License as published by
22 * the Free Software Foundation, either version 3 of the License, or
23 * (at your option) any later version.
25 * This program is distributed in the hope that it will be useful,
26 * but WITHOUT ANY WARRANTY; without even the implied warranty of
27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 * GNU General Public License for more details.
30 * You should have received a copy of the GNU General Public License
31 * along with this program. If not, see <http://www.gnu.org/licenses/>.
33 class HtmlCityLoginLogoutAction extends BaseCityAction implements Commandable, Registerable {
35 * Protected constructor
39 protected function __construct () {
40 // Call parent constructor
41 parent::__construct(__CLASS__);
45 * Creates an instance of this action
47 * @param $resolverInstance An instance of an action resolver
48 * @return $actionInstance An instance of this action class
50 public static final function createHtmlCityLoginLogoutAction (ActionResolver $resolverInstance) {
52 $actionInstance = new HtmlCityLoginLogoutAction();
54 // Set the resolver instance
55 $actionInstance->setResolverInstance($resolverInstance);
57 // Return the instance
58 return $actionInstance;
62 * Executes the command with given request and response objects
64 * @param $requestInstance An instance of a class with an Requestable interface
65 * @param $responseInstance An instance of a class with an Responseable interface
69 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
70 // Call parent execute method
71 parent::execute($requestInstance, $responseInstance);
77 * Adds extra filters to the given controller instance
79 * @param $controllerInstance A controller instance
80 * @param $requestInstance An instance of a class with an Requestable interface
83 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
84 // Check for user status by default
85 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_status_filter'));