3 * A database wrapper for city lots
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2015, 2016 City Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
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.
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.
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/>.
24 class CityLotsDatabaseWrapper extends BaseDatabaseWrapper implements CityLotsWrapper, Registerable {
25 // Constants for database table names
26 const DB_TABLE_CITY_LOTS = 'city_lots';
28 // Section id, an referenced city id and lot id
29 const DB_COLUMN_CITY_ID = 'city_id';
30 const DB_COLUMN_LOT_ID = 'lot_id';
31 const DB_COLUMN_DISTRICT_ID = 'district_id';
34 * Protected constructor
38 protected function __construct () {
39 // Call parent constructor
40 parent::__construct(__CLASS__);
44 * Creates an instance of this database wrapper by a provided user class
46 * @return $wrapperInstance An instance of the created wrapper class
48 public static final function createCityLotsDatabaseWrapper () {
50 $wrapperInstance = new CityLotsDatabaseWrapper();
52 // Set (primary!) table name
53 $wrapperInstance->setTableName(self::DB_TABLE_CITY_LOTS);
55 // Return the instance
56 return $wrapperInstance;
60 * Checks if the given city id is found in lots table
62 * @param $cityId City id to check
63 * @return $isFound Whether the city id is found
65 public function ifCityHasLots ($cityId) {
66 // Get search instance
67 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
69 // Search for 'city_id'
70 $searchInstance->addCriteria(self::DB_COLUMN_CITY_ID, $cityId);
73 * Only one entry is enough to find, else this query could run very
76 $searchInstance->setLimit(1);
78 // Execute it on database instance
79 $resultInstance = $this->doSelectByCriteria($searchInstance);
81 // Check if there is one entry
82 $isFound = $resultInstance->next();