3 * A concrete filter for verfying the city name. This filter may intercept the
4 * filter chain if no city name is given or if supplied city name has an invalid
5 * form. It could also intercept our filter chain if city name was not found.
7 * @author Roland Haeder <webmaster@shipsimu.org>
9 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
10 * @license GNU GPL 3.0 or any newer version
11 * @link http://www.shipsimu.org
13 * This program is free software: you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation, either version 3 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26 class CityNameVerifierFilter extends BaseFilter implements Filterable {
28 * Protected constructor
32 protected function __construct () {
33 // Call parent constructor
34 parent::__construct(__CLASS__);
38 * Creates an instance of this filter class
40 * @return $filterInstance An instance of this filter class
42 public static final function createCityNameVerifierFilter () {
44 $filterInstance = new CityNameVerifierFilter();
46 // Return the instance
47 return $filterInstance;
51 * Executes the filter with given request and response objects
53 * @param $requestInstance An instance of a class with an Requestable interface
54 * @param $responseInstance An instance of a class with an Responseable interface
56 * @throws FilterChainException If this filter fails to operate
58 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
59 // Get city name from request
60 $cityName = $requestInstance->getRequestElement('city_name');
62 // Is the city name set?
63 if (is_null($cityName)) {
64 // Not found in form so stop the filtering process
65 $requestInstance->requestIsValid(FALSE);
67 // Add a message to the response
68 $responseInstance->addFatalMessage('city_name_unset');
71 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
72 } elseif (empty($cityName)) {
74 $requestInstance->requestIsValid(FALSE);
76 // Add a message to the response
77 $responseInstance->addFatalMessage('city_name_empty');
80 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
81 } elseif ($this->ifCityNameIsTaken($cityName) === TRUE) {
82 // City name is already taken
83 $requestInstance->requestIsValid(FALSE);
85 // Add a message to the response
86 $responseInstance->addFatalMessage('city_name_taken');
89 throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
94 * Check whether the city name as already been taken
96 * @param $cityName Cityname to check for existence
97 * @return $alreadyTaken Whether the city name has been taken
99 private function ifCityNameIsTaken ($cityName) {
100 // Get a new instance
101 $managerInstance = ManagerFactory::createManagerByType('city');
103 // Does the city name exist?
104 $alreadyTaken = ($managerInstance->ifCityNameExists($cityName));
107 return $alreadyTaken;