application/city/classes/filter/verifier/class_CityNameVerifierFilter.php

   1 <?php
   2 /**
   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.
   6  *
   7  * @author              Roland Haeder <webmaster@shipsimu.org>
   8  * @version             0.0.0
   9  * @copyright   Copyright (c) 2015 City Developer Team
  10  * @license             GNU GPL 3.0 or any newer version
  11  * @link                http://www.shipsimu.org
  12  *
  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.
  17  *
  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.
  22  *
  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/>.
  25  */
  26 class CityNameVerifierFilter extends BaseFilter implements Filterable {
  27         /**
  28          * Protected constructor
  29          *
  30          * @return      void
  31          */
  32         protected function __construct () {
  33                 // Call parent constructor
  34                 parent::__construct(__CLASS__);
  35         }
  36
  37         /**
  38          * Creates an instance of this filter class
  39          *
  40          * @return      $filterInstance         An instance of this filter class
  41          */
  42         public static final function createCityNameVerifierFilter () {
  43                 // Get a new instance
  44                 $filterInstance = new CityNameVerifierFilter();
  45
  46                 // Return the instance
  47                 return $filterInstance;
  48         }
  49
  50         /**
  51          * Executes the filter with given request and response objects
  52          *
  53          * @param       $requestInstance        An instance of a class with an Requestable interface
  54          * @param       $responseInstance       An instance of a class with an Responseable interface
  55          * @return      void
  56          * @throws      FilterChainException    If this filter fails to operate
  57          */
  58         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  59                 // Get city name from request
  60                 $cityName = $requestInstance->getRequestElement(CityInformationDatabaseWrapper::DB_COLUMN_CITY_NAME);
  61
  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);
  66
  67                         // Add a message to the response
  68                         $responseInstance->addFatalMessage('city_name_unset');
  69
  70                         // Abort here
  71                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  72                 } elseif (empty($cityName)) {
  73                         // Empty field!
  74                         $requestInstance->requestIsValid(FALSE);
  75
  76                         // Add a message to the response
  77                         $responseInstance->addFatalMessage('city_name_empty');
  78
  79                         // Abort here
  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);
  84
  85                         // Add a message to the response
  86                         $responseInstance->addFatalMessage('city_name_taken');
  87
  88                         // Abort here
  89                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  90                 }
  91         }
  92
  93         /**
  94          * Check whether the city name as already been taken
  95          *
  96          * @param       $cityName               Cityname to check for existence
  97          * @return      $alreadyTaken   Whether the city name has been taken
  98          */
  99         private function ifCityNameIsTaken ($cityName) {
 100                 // Get a new instance
 101                 $managerInstance = ManagerFactory::createManagerByType('city');
 102
 103                 // Does the city name exist?
 104                 $alreadyTaken = ($managerInstance->ifCityNameExists($cityName));
 105
 106                 // Return the result
 107                 return $alreadyTaken;
 108         }
 109 }
 110
 111 // [EOF]
 112 ?>