application/city/classes/database/frontend/city_entities/districts/class_CityDistrictsDatabaseWrapper.php

   1 <?php
   2 /**
   3  * A database wrapper for city districts
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2015 City Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class CityDistrictsDatabaseWrapper extends BaseDatabaseWrapper implements CityDistrictsWrapper, Registerable {
  25         // Constants for database table names
  26         const DB_TABLE_CITY_DISTRICTS = 'city_districts';
  27
  28         // Section id, an referenced city id and district id
  29         const DB_COLUMN_CITY_ID                = 'city_id';
  30         const DB_COLUMN_DISTRICT_ID            = 'district_id';
  31
  32         /**
  33          * Protected constructor
  34          *
  35          * @return      void
  36          */
  37         protected function __construct () {
  38                 // Call parent constructor
  39                 parent::__construct(__CLASS__);
  40         }
  41
  42         /**
  43          * Creates an instance of this database wrapper by a provided user class
  44          *
  45          * @return      $wrapperInstance        An instance of the created wrapper class
  46          */
  47         public static final function createCityDistrictsDatabaseWrapper () {
  48                 // Get a new instance
  49                 $wrapperInstance = new CityDistrictsDatabaseWrapper();
  50
  51                 // Set (primary!) table name
  52                 $wrapperInstance->setTableName(self::DB_TABLE_CITY_DISTRICTS);
  53
  54                 // Return the instance
  55                 return $wrapperInstance;
  56         }
  57
  58         /**
  59          * Checks if the given city id is found in districts table
  60          *
  61          * @param       $cityId         City id to check
  62          * @return      $isFound        Whether the city id is found
  63          */
  64         public function ifCityHasDistricts ($cityId) {
  65                 // Get search instance
  66                 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
  67
  68                 // Search for 'city_id'
  69                 $searchInstance->addCriteria(self::DB_COLUMN_CITY_ID, $cityId);
  70
  71                 /*
  72                  * Only one entry is enough to find, else this query could run very\
  73                  * long on large maps.
  74                  */
  75                 $searchInstance->setLimit(1);
  76
  77                 // Execute it on database instance
  78                 $resultInstance = $this->doSelectByCriteria($searchInstance);
  79
  80                 // Check if there is one entry
  81                 $isFound = ($resultInstance->next() == 1);
  82
  83                 // Return result
  84                 return $isFound;
  85         }
  86 }
  87
  88 // [EOF]
  89 ?>