From 82bcf553b0328a7ccb1f2a33d45532002ce7c2c9 Mon Sep 17 00:00:00 2001 From: Roland Haeder Date: Tue, 24 Mar 2015 18:20:27 +0100 Subject: [PATCH] Added more console and database frontend classes. Signed-off-by: Roland Haeder --- application/city/config.php | 3 + .../city/interfaces/database/.htaccess | 1 + .../interfaces/database/frontend/.htaccess | 1 + .../frontend/class_CityInformationWrapper.php | 37 +++++ application/city/main/city/class_ | 8 +- application/city/main/class_ | 2 +- application/city/main/database/.htaccess | 1 + .../city/main/database/frontend/.htaccess | 1 + .../main/database/frontend/city/.htaccess | 1 + .../class_CityInformationDatabaseWrapper.php | 129 ++++++++++++++++++ .../city/main/factories/states/.htaccess | 1 + .../city/main/factories/states/city/.htaccess | 1 + .../states/city/class_CityStateFactory.php | 65 +++++++++ application/city/main/states/.htaccess | 1 + application/city/main/states/city/.htaccess | 1 + application/city/main/states/city/class_ | 60 ++++++++ .../main/states/city/class_BaseCityState.php | 53 +++++++ .../states/city/init/class_CityInitState.php | 57 ++++++++ core | 2 +- 19 files changed, 419 insertions(+), 6 deletions(-) create mode 100644 application/city/interfaces/database/.htaccess create mode 100644 application/city/interfaces/database/frontend/.htaccess create mode 100644 application/city/interfaces/database/frontend/class_CityInformationWrapper.php create mode 100644 application/city/main/database/.htaccess create mode 100644 application/city/main/database/frontend/.htaccess create mode 100644 application/city/main/database/frontend/city/.htaccess create mode 100644 application/city/main/database/frontend/city/class_CityInformationDatabaseWrapper.php create mode 100644 application/city/main/factories/states/.htaccess create mode 100644 application/city/main/factories/states/city/.htaccess create mode 100644 application/city/main/factories/states/city/class_CityStateFactory.php create mode 100644 application/city/main/states/.htaccess create mode 100644 application/city/main/states/city/.htaccess create mode 100644 application/city/main/states/city/class_ create mode 100644 application/city/main/states/city/class_BaseCityState.php create mode 100644 application/city/main/states/city/init/class_CityInitState.php diff --git a/application/city/config.php b/application/city/config.php index 293d044..0a5c1b6 100644 --- a/application/city/config.php +++ b/application/city/config.php @@ -43,6 +43,9 @@ $cfg->setConfigEntry('news_reader_class', 'ConsoleNewsReader'); // CFG: CITY-INFO-DB-WRAPPER-CLASS $cfg->setConfigEntry('city_info_db_wrapper_class', 'CityInformationDatabaseWrapper'); +// CFG: CITY-INIT-STATE-CLASS +$cfg->setConfigEntry('city_init_state_class', 'CityInitState'); + /****************************************************************************** * HTML client * ******************************************************************************/ diff --git a/application/city/interfaces/database/.htaccess b/application/city/interfaces/database/.htaccess new file mode 100644 index 0000000..3a42882 --- /dev/null +++ b/application/city/interfaces/database/.htaccess @@ -0,0 +1 @@ +Deny from all diff --git a/application/city/interfaces/database/frontend/.htaccess b/application/city/interfaces/database/frontend/.htaccess new file mode 100644 index 0000000..3a42882 --- /dev/null +++ b/application/city/interfaces/database/frontend/.htaccess @@ -0,0 +1 @@ +Deny from all diff --git a/application/city/interfaces/database/frontend/class_CityInformationWrapper.php b/application/city/interfaces/database/frontend/class_CityInformationWrapper.php new file mode 100644 index 0000000..5f2edbc --- /dev/null +++ b/application/city/interfaces/database/frontend/class_CityInformationWrapper.php @@ -0,0 +1,37 @@ + + * @version 0.0.0 + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 City Developer Team + * @license GNU GPL 3.0 or any newer version + * @link http://www.shipsimu.org + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +interface CityInformationWrapper extends DatabaseWrapper { + /** + * 'Registers' a new city id along with data provided in the city instance. + * This may sound confusing but avoids double code very nicely... + * + * @param $cityInstance A city instance + * @param $requestInstance An instance of a Requestable class + * @return void + */ + function registerCityId (BaseCity $cityInstance, Requestable $requestInstance); +} + +// [EOF] +?> diff --git a/application/city/main/city/class_ b/application/city/main/city/class_ index 915a3e8..19410ec 100644 --- a/application/city/main/city/class_ +++ b/application/city/main/city/class_ @@ -21,7 +21,7 @@ * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ -class Hub???Node extends BaseHubNode implements NodeHelper, Registerable { +class Simulation???City extends BaseCity implements CityHelper, Registerable { /** * Protected constructor * @@ -38,9 +38,9 @@ class Hub???Node extends BaseHubNode implements NodeHelper, Registerable { * @param $requestInstance An instance of a Requestable class * @return $nodeInstance An instance of this hub-node class */ - public final static function createHub???Node (Requestable $requestInstance) { + public final static function createCity???City (Requestable $requestInstance) { // Get a new instance - $nodeInstance = new Hub???Node(); + $nodeInstance = new City???City(); // Set the request instance $nodeInstance->setRequestInstance($requestInstance); @@ -78,7 +78,7 @@ class Hub???Node extends BaseHubNode implements NodeHelper, Registerable { * * @return void */ - public function addExtraHubFilters () { + public function addExtraCityFilters () { // Add some filters here } diff --git a/application/city/main/class_ b/application/city/main/class_ index 2dea4bd..2ebd875 100644 --- a/application/city/main/class_ +++ b/application/city/main/class_ @@ -4,7 +4,7 @@ * * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team + * @copyright Copyright (c) 2015 City Developer Team * @license GNU GPL 3.0 or any newer version * @link http://www.ship-simu.org * diff --git a/application/city/main/database/.htaccess b/application/city/main/database/.htaccess new file mode 100644 index 0000000..3a42882 --- /dev/null +++ b/application/city/main/database/.htaccess @@ -0,0 +1 @@ +Deny from all diff --git a/application/city/main/database/frontend/.htaccess b/application/city/main/database/frontend/.htaccess new file mode 100644 index 0000000..3a42882 --- /dev/null +++ b/application/city/main/database/frontend/.htaccess @@ -0,0 +1 @@ +Deny from all diff --git a/application/city/main/database/frontend/city/.htaccess b/application/city/main/database/frontend/city/.htaccess new file mode 100644 index 0000000..3a42882 --- /dev/null +++ b/application/city/main/database/frontend/city/.htaccess @@ -0,0 +1 @@ +Deny from all diff --git a/application/city/main/database/frontend/city/class_CityInformationDatabaseWrapper.php b/application/city/main/database/frontend/city/class_CityInformationDatabaseWrapper.php new file mode 100644 index 0000000..641e763 --- /dev/null +++ b/application/city/main/database/frontend/city/class_CityInformationDatabaseWrapper.php @@ -0,0 +1,129 @@ + + * @version 0.0.0 + * @copyright Copyright (c) 2015 City Developer Team + * @license GNU GPL 3.0 or any newer version + * @link http://www.shipsimu.org + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +class CityInformationDatabaseWrapper extends BaseDatabaseWrapper implements CityInformationWrapper, Registerable { + // Constants for database table names + const DB_TABLE_CITY_INFORMATION = 'city_data'; + + // Constants for database column names + const DB_COLUMN_CITY_NR = 'city_nr'; + const DB_COLUMN_CITY_ID = 'city_id'; + const DB_COLUMN_CITY_MODE = 'city_mode'; + + /** + * Protected constructor + * + * @return void + */ + protected function __construct () { + // Call parent constructor + parent::__construct(__CLASS__); + } + + /** + * Creates an instance of this database wrapper by a provided user class + * + * @return $wrapperInstance An instance of the created wrapper class + */ + public static final function createCityInformationDatabaseWrapper () { + // Get a new instance + $wrapperInstance = new CityInformationDatabaseWrapper(); + + // Set (primary!) table name + $wrapperInstance->setTableName(self::DB_TABLE_CITY_INFORMATION); + + // Return the instance + return $wrapperInstance; + } + + /** + * Checks whether there is an entry for given city instance + * + * @param $cityInstance An instance of a CityHelper class + * @return $isFound Whether a city id has been found for this city + */ + public function ifCityDataIsFound (CityHelper $cityInstance) { + // Is there cache? + if (!isset($GLOBALS[__METHOD__])) { + // Now get a search criteria instance + $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class'); + + // Search for the city number one which is hard-coded the default + $searchInstance->addCriteria(CityInformationDatabaseWrapper::DB_COLUMN_CITY_NR , 1); + $searchInstance->addCriteria(CityInformationDatabaseWrapper::DB_COLUMN_CITY_MODE, $cityInstance->getRequestInstance()->getRequestElement('mode')); + $searchInstance->setLimit(1); + + // Get a result back + $resultInstance = $this->doSelectByCriteria($searchInstance); + + // Set result instance in city instance + $cityInstance->setResultInstance($resultInstance); + + // Is it valid? + $GLOBALS[__METHOD__] = $resultInstance->next(); + } // END - if + + // Return it + return $GLOBALS[__METHOD__]; + } + + /** + * 'Registers' a new city id along with data provided in the city instance. + * This may sound confusing but avoids double code very nicely... + * + * @param $cityInstance A city instance + * @param $requestInstance An instance of a Requestable class + * @return void + */ + public function registerCityId (BaseCity $cityInstance, Requestable $requestInstance) { + // Get a dataset instance + $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_CITY_INFORMATION)); + + // Set the primary key + $dataSetInstance->setUniqueKey(self::DB_COLUMN_CITY_ID); + + // Add registration elements to the dataset + $cityInstance->addElementsToDataSet($dataSetInstance, $requestInstance); + + // "Insert" this dataset instance completely into the database + $this->queryInsertDataSet($dataSetInstance); + } + + /** + * Removes non-public data from given array. + * + * @param $data An array with possible non-public data that needs to be removed. + * @return $data A cleaned up array with only public data. + */ + public function removeNonPublicDataFromArray(array $data) { + // Currently call only inner method + /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CITY-WRAPPER[' . __METHOD__ . ':' . __LINE__ . ']: Calling parent::removeNonPublicDataFromArray(data) ...'); + $data = parent::removeNonPublicDataFromArray($data); + + // Return cleaned data + return $data; + } +} + +// [EOF] +?> diff --git a/application/city/main/factories/states/.htaccess b/application/city/main/factories/states/.htaccess new file mode 100644 index 0000000..3a42882 --- /dev/null +++ b/application/city/main/factories/states/.htaccess @@ -0,0 +1 @@ +Deny from all diff --git a/application/city/main/factories/states/city/.htaccess b/application/city/main/factories/states/city/.htaccess new file mode 100644 index 0000000..3a42882 --- /dev/null +++ b/application/city/main/factories/states/city/.htaccess @@ -0,0 +1 @@ +Deny from all diff --git a/application/city/main/factories/states/city/class_CityStateFactory.php b/application/city/main/factories/states/city/class_CityStateFactory.php new file mode 100644 index 0000000..8c8fffe --- /dev/null +++ b/application/city/main/factories/states/city/class_CityStateFactory.php @@ -0,0 +1,65 @@ + + * @version 0.0.0 + * @copyright Copyright (c) 2015 City Developer Team + * @license GNU GPL 3.0 or any newer version + * @link http://www.shipsimu.org + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +class CityStateFactory extends ObjectFactory { + /** + * Protected constructor + * + * @return void + */ + protected function __construct () { + // Call parent constructor + parent::__construct(__CLASS__); + } + + /** + * Creates an instance of a configurable city state and sets it in the + * given city instance. + * + * @param $stateName Name of the state + * @param $cityInstance A CityHelper class instance + * @return $stateInstance A Stateable class instance + */ + public static final function createCityStateInstanceByName ($stateName, CityHelper $cityInstance) { + // Then construct the class' configuraton entry + $className = 'city_' . $stateName . '_state_class'; + + // Get a class from that configuration entry + $stateInstance = self::createObjectByConfiguredName($className, array($cityInstance)); + + // Debug message + self::createDebugInstance(__CLASS__)->debugOutput('CITY-STATE-FACTORY[' . __METHOD__ . ':' . __LINE__ . ']: City state has changed from ' . $cityInstance->getPrintableState() . ' to ' . $stateInstance->getStateName() . '.'); + + // Once we have that state, set it in the city instance + $cityInstance->setStateInstance($stateInstance); + + // Update city data + $cityInstance->updateCityData(); + + // For any purposes, return the state instance + return $stateInstance; + } +} + +// [EOF] +?> diff --git a/application/city/main/states/.htaccess b/application/city/main/states/.htaccess new file mode 100644 index 0000000..3a42882 --- /dev/null +++ b/application/city/main/states/.htaccess @@ -0,0 +1 @@ +Deny from all diff --git a/application/city/main/states/city/.htaccess b/application/city/main/states/city/.htaccess new file mode 100644 index 0000000..3a42882 --- /dev/null +++ b/application/city/main/states/city/.htaccess @@ -0,0 +1 @@ +Deny from all diff --git a/application/city/main/states/city/class_ b/application/city/main/states/city/class_ new file mode 100644 index 0000000..5df9aa5 --- /dev/null +++ b/application/city/main/states/city/class_ @@ -0,0 +1,60 @@ + + * @version 0.0.0 + * @copyright Copyright (c) 2015 City Developer Team + * @license GNU GPL 3.0 or any newer version + * @link http://www.ship-simu.org + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +class City???State extends BaseCityState implements Stateable { + /** + * Protected constructor + * + * @return void + */ + protected function __construct () { + // Call parent constructor + parent::__construct(__CLASS__); + + // Set state name + $this->setStateName('!!!'); + } + + /** + * Creates an instance of this class + * + * @param $cityInstance An instance of a CityHelper class + * @return $stateInstance An instance of a Stateable class + */ + public final static function createCity???State (CityHelper $cityInstance) { + // Get new instance + $stateInstance = new City???State(); + + // Debug message + //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('CITY-STATE: Has changed from ' . $cityInstance->getPrintableState() . ' to ' . $stateInstance->getStateName() . '.'); + + // Set the city instance + $stateInstance->setCityInstance($cityInstance); + + // Return the prepared instance + return $stateInstance; + } +} + +// [EOF] +?> diff --git a/application/city/main/states/city/class_BaseCityState.php b/application/city/main/states/city/class_BaseCityState.php new file mode 100644 index 0000000..fb05751 --- /dev/null +++ b/application/city/main/states/city/class_BaseCityState.php @@ -0,0 +1,53 @@ + + * @version 0.0.0 + * @copyright Copyright (c) 2015 City Developer Team + * @license GNU GPL 3.0 or any newer version + * @link http://www.shipsimu.org + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +class BaseCityState extends BaseState { + /** + * Protected constructor + * + * @param $className Name of the class + * @return void + */ + protected function __construct ($className) { + // Call parent constructor + parent::__construct($className); + } + + /** + * Validates whether the state is 'active' or throws an exception if + * it is every other state. + * + * @return void + * @throws InvalidStateException If the state is not 'active' + */ + public function validateCityStateIsActive () { + // Just compare it... + if (!$this instanceof CityActiveState) { + // Throw the exception + throw new InvalidStateException($this, self::EXCEPTION_INVALID_STATE); + } // END - if + } +} + +// [EOF] +?> diff --git a/application/city/main/states/city/init/class_CityInitState.php b/application/city/main/states/city/init/class_CityInitState.php new file mode 100644 index 0000000..28584cd --- /dev/null +++ b/application/city/main/states/city/init/class_CityInitState.php @@ -0,0 +1,57 @@ + + * @version 0.0.0 + * @copyright Copyright (c) 2015 City Developer Team + * @license GNU GPL 3.0 or any newer version + * @link http://www.shipsimu.org + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +class CityInitState extends BaseCityState implements Stateable { + /** + * Protected constructor + * + * @return void + */ + protected function __construct () { + // Call parent constructo + parent::__construct(__CLASS__); + + // Set state name + $this->setStateName('init'); + } + + /** + * Creates an instance of this class + * + * @param $cityInstance An instance of a CityHelper class + * @return $stateInstance An instance of a Stateable class + */ + public static final function createCityInitState (CityHelper $cityInstance) { + // Get new instance + $stateInstance = new CityInitState(); + + // Set the city instance + $stateInstance->setCityInstance($cityInstance); + + // Return the prepared instance + return $stateInstance; + } +} + +// [EOF] +?> diff --git a/core b/core index 87b2be5..c0922d6 160000 --- a/core +++ b/core @@ -1 +1 @@ -Subproject commit 87b2be57b63b6e923aab40e0fbba2ff86db88a86 +Subproject commit c0922d6cccd0fb0f1b5221585748e92d02ad1cee -- 2.39.5