3 namespace Org\Mxchange\City\Filter\Verifier;
5 // Import application-specific stuff
6 use Org\Mxchange\City\Database\Frontend\Information\CityInformationDatabaseFrontend;
7 use Org\Mxchange\City\Factory\Manager\ManagerFactory;
9 // Import framework stuff
10 use Org\Mxchange\CoreFramework\Filter\BaseFilter;
11 use Org\Mxchange\CoreFramework\Filter\Chain\FilterChainException;
12 use Org\Mxchange\CoreFramework\Filter\Filterable;
13 use Org\Mxchange\CoreFramework\Request\Requestable;
14 use Org\Mxchange\CoreFramework\Response\Responseable;
17 * A concrete filter for verfying the city name. This filter may intercept the
18 * filter chain if no city name is given or if supplied city name has an invalid
19 * form. It could also intercept our filter chain if city name was not found.
21 * @author Roland Haeder <webmaster@shipsimu.org>
23 * @copyright Copyright (c) 2015 - 2023 City Developer Team
24 * @license GNU GPL 3.0 or any newer version
25 * @link http://www.shipsimu.org
27 * This program is free software: you can redistribute it and/or modify
28 * it under the terms of the GNU General Public License as published by
29 * the Free Software Foundation, either version 3 of the License, or
30 * (at your option) any later version.
32 * This program is distributed in the hope that it will be useful,
33 * but WITHOUT ANY WARRANTY; without even the implied warranty of
34 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
35 * GNU General Public License for more details.
37 * You should have received a copy of the GNU General Public License
38 * along with this program. If not, see <http://www.gnu.org/licenses/>.
40 class CityNameVerifierFilter extends BaseFilter implements Filterable {
42 * Protected constructor
46 protected function __construct () {
47 // Call parent constructor
48 parent::__construct(__CLASS__);
52 * Creates an instance of this filter class
54 * @return $filterInstance An instance of this filter class
56 public static final function createCityNameVerifierFilter () {
58 $filterInstance = new CityNameVerifierFilter();
60 // Return the instance
61 return $filterInstance;
65 * Executes the filter with given request and response objects
67 * @param $requestInstance An instance of a class with an Requestable interface
68 * @param $responseInstance An instance of a class with an Responseable interface
70 * @throws FilterChainException If this filter fails to operate
72 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
73 // Get city name from request
74 $cityName = $requestInstance->getRequestElement(CityInformationDatabaseFrontend::DB_COLUMN_CITY_NAME);
76 // Is the city name set?
77 if (is_null($cityName)) {
78 // Not found in form so stop the filtering process
79 $requestInstance->setIsRequestValid(FALSE);
81 // Add a message to the response
82 $responseInstance->addFatalMessage('city_name_unset');
85 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
86 } elseif (empty($cityName)) {
88 $requestInstance->setIsRequestValid(FALSE);
90 // Add a message to the response
91 $responseInstance->addFatalMessage('city_name_empty');
94 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
95 } elseif ($this->ifCityNameIsTaken($cityName) === TRUE) {
96 // City name is already taken
97 $requestInstance->setIsRequestValid(FALSE);
99 // Add a message to the response
100 $responseInstance->addFatalMessage('city_name_taken');
103 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
108 * Check whether the city name as already been taken
110 * @param $cityName Cityname to check for existence
111 * @return $alreadyTaken Whether the city name has been taken
113 private function ifCityNameIsTaken (string $cityName) {
114 // Get a new instance
115 $managerInstance = ManagerFactory::createManagerByType('city');
117 // Make sure the instance is valid
118 assert($managerInstance instanceof ManageableCity);
120 // Does the city name exist?
121 $alreadyTaken = ($managerInstance->ifCityNameExists($cityName));
124 return $alreadyTaken;