3 namespace Org\Mxchange\City\Filter\Verifier;
5 // Import application-specific stuff
6 use Org\Mxchange\City\Database\Frontend\Information\CityInformationDatabaseWrapper;
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\Filterable;
12 use Org\Mxchange\CoreFramework\Request\Requestable;
13 use Org\Mxchange\CoreFramework\Response\Responseable;
16 * A concrete filter for verfying the city name. This filter may intercept the
17 * filter chain if no city name is given or if supplied city name has an invalid
18 * form. It could also intercept our filter chain if city name was not found.
20 * @author Roland Haeder <webmaster@shipsimu.org>
22 * @copyright Copyright (c) 2015, 2016 City Developer Team
23 * @license GNU GPL 3.0 or any newer version
24 * @link http://www.shipsimu.org
26 * This program is free software: you can redistribute it and/or modify
27 * it under the terms of the GNU General Public License as published by
28 * the Free Software Foundation, either version 3 of the License, or
29 * (at your option) any later version.
31 * This program is distributed in the hope that it will be useful,
32 * but WITHOUT ANY WARRANTY; without even the implied warranty of
33 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
34 * GNU General Public License for more details.
36 * You should have received a copy of the GNU General Public License
37 * along with this program. If not, see <http://www.gnu.org/licenses/>.
39 class CityNameVerifierFilter extends BaseFilter implements Filterable {
41 * Protected constructor
45 protected function __construct () {
46 // Call parent constructor
47 parent::__construct(__CLASS__);
51 * Creates an instance of this filter class
53 * @return $filterInstance An instance of this filter class
55 public static final function createCityNameVerifierFilter () {
57 $filterInstance = new CityNameVerifierFilter();
59 // Return the instance
60 return $filterInstance;
64 * Executes the filter with given request and response objects
66 * @param $requestInstance An instance of a class with an Requestable interface
67 * @param $responseInstance An instance of a class with an Responseable interface
69 * @throws FilterChainException If this filter fails to operate
71 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
72 // Get city name from request
73 $cityName = $requestInstance->getRequestElement(CityInformationDatabaseWrapper::DB_COLUMN_CITY_NAME);
75 // Is the city name set?
76 if (is_null($cityName)) {
77 // Not found in form so stop the filtering process
78 $requestInstance->requestIsValid(FALSE);
80 // Add a message to the response
81 $responseInstance->addFatalMessage('city_name_unset');
84 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
85 } elseif (empty($cityName)) {
87 $requestInstance->requestIsValid(FALSE);
89 // Add a message to the response
90 $responseInstance->addFatalMessage('city_name_empty');
93 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
94 } elseif ($this->ifCityNameIsTaken($cityName) === TRUE) {
95 // City name is already taken
96 $requestInstance->requestIsValid(FALSE);
98 // Add a message to the response
99 $responseInstance->addFatalMessage('city_name_taken');
102 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
107 * Check whether the city name as already been taken
109 * @param $cityName Cityname to check for existence
110 * @return $alreadyTaken Whether the city name has been taken
112 private function ifCityNameIsTaken ($cityName) {
113 // Get a new instance
114 $managerInstance = ManagerFactory::createManagerByType('city');
116 // Make sure the instance is valid
117 assert($managerInstance instanceof ManageableCity);
119 // Does the city name exist?
120 $alreadyTaken = ($managerInstance->ifCityNameExists($cityName));
123 return $alreadyTaken;