3 namespace Org\Mxchange\City\Filter\Verifier;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Request\Requestable;
7 use Org\Mxchange\CoreFramework\Response\Responseable;
10 * A concrete filter for verfying the city name. This filter may intercept the
11 * filter chain if no city name is given or if supplied city name has an invalid
12 * form. It could also intercept our filter chain if city name was not found.
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 CityNameVerifierFilter extends BaseFilter implements Filterable {
35 * Protected constructor
39 protected function __construct () {
40 // Call parent constructor
41 parent::__construct(__CLASS__);
45 * Creates an instance of this filter class
47 * @return $filterInstance An instance of this filter class
49 public static final function createCityNameVerifierFilter () {
51 $filterInstance = new CityNameVerifierFilter();
53 // Return the instance
54 return $filterInstance;
58 * Executes the filter with given request and response objects
60 * @param $requestInstance An instance of a class with an Requestable interface
61 * @param $responseInstance An instance of a class with an Responseable interface
63 * @throws FilterChainException If this filter fails to operate
65 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
66 // Get city name from request
67 $cityName = $requestInstance->getRequestElement(CityInformationDatabaseWrapper::DB_COLUMN_CITY_NAME);
69 // Is the city name set?
70 if (is_null($cityName)) {
71 // Not found in form so stop the filtering process
72 $requestInstance->requestIsValid(FALSE);
74 // Add a message to the response
75 $responseInstance->addFatalMessage('city_name_unset');
78 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
79 } elseif (empty($cityName)) {
81 $requestInstance->requestIsValid(FALSE);
83 // Add a message to the response
84 $responseInstance->addFatalMessage('city_name_empty');
87 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
88 } elseif ($this->ifCityNameIsTaken($cityName) === TRUE) {
89 // City name is already taken
90 $requestInstance->requestIsValid(FALSE);
92 // Add a message to the response
93 $responseInstance->addFatalMessage('city_name_taken');
96 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
101 * Check whether the city name as already been taken
103 * @param $cityName Cityname to check for existence
104 * @return $alreadyTaken Whether the city name has been taken
106 private function ifCityNameIsTaken ($cityName) {
107 // Get a new instance
108 $managerInstance = ManagerFactory::createManagerByType('city');
110 // Make sure the instance is valid
111 assert($managerInstance instanceof ManageableCity);
113 // Does the city name exist?
114 $alreadyTaken = ($managerInstance->ifCityNameExists($cityName));
117 return $alreadyTaken;