3 namespace Org\Mxchange\City\Action;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Controller\Controller;
7 use Org\Mxchange\CoreFramework\Request\Requestable;
8 use Org\Mxchange\CoreFramework\Response\Responseable;
11 * A general action class for city
13 * @author Roland Haeder <webmaster@shipsimu.org>
15 * @copyright Copyright (c) 2015 - 2023 City Developer Team
16 * @license GNU GPL 3.0 or any newer version
17 * @link http://www.shipsimu.org
19 * This program is free software: you can redistribute it and/or modify
20 * it under the terms of the GNU General Public License as published by
21 * the Free Software Foundation, either version 3 of the License, or
22 * (at your option) any later version.
24 * This program is distributed in the hope that it will be useful,
25 * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27 * GNU General Public License for more details.
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
32 abstract class BaseCityAction extends BaseAction {
34 * Protected constructor
36 * @param $className Name of the class
39 protected function __construct (string $className) {
40 // Call parent constructor
41 parent::__construct($className);
45 * Executes the command with given request and response objects
47 * @param $requestInstance An instance of a class with an Requestable interface
48 * @param $responseInstance An instance of a class with an Responseable interface
52 protected function execute (Requestable $requestInstance, Responseable $responseInstance) {
53 // Add code here executed with every action
57 * Adds extra filters to the given controller instance
59 * @param $controllerInstance A controller instance
60 * @param $requestInstance An instance of a class with an Requestable interface
62 * @todo Add some filters here
64 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {