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

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