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