3 namespace Org\Mxchange\City\Factory\State;
5 // Import application-specific stuff
6 use Org\Mxchange\City\Daemon\Factory\CityDaemonFactory;
8 // Import framework stuff
9 use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
12 * A factory class for city states
14 * @author Roland Haeder <webmaster@shipsimu.org>
16 * @copyright Copyright (c) 2015, 2016 City Developer Team
17 * @license GNU GPL 3.0 or any newer version
18 * @link http://www.shipsimu.org
20 * This program is free software: you can redistribute it and/or modify
21 * it under the terms of the GNU General Public License as published by
22 * the Free Software Foundation, either version 3 of the License, or
23 * (at your option) any later version.
25 * This program is distributed in the hope that it will be useful,
26 * but WITHOUT ANY WARRANTY; without even the implied warranty of
27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 * GNU General Public License for more details.
30 * You should have received a copy of the GNU General Public License
31 * along with this program. If not, see <http://www.gnu.org/licenses/>.
33 class CityStateFactory extends ObjectFactory {
35 * Protected constructor
39 protected function __construct () {
40 // Call parent constructor
41 parent::__construct(__CLASS__);
45 * Creates an instance of a configurable city state and sets it in the
46 * given city instance.
48 * @param $stateName Name of the state
49 * @return $stateInstance A Stateable class instance
51 public static final function createCityStateInstanceByName ($stateName) {
52 // Then construct the class' configuraton entry
53 $className = 'city_' . $stateName . '_state_class';
55 // Get a class from that configuration entry
56 $stateInstance = self::createObjectByConfiguredName($className);
59 $cityInstance = CityDaemonFactory::createCityDaemonInstance();
62 self::createDebugInstance(__CLASS__)->debugOutput('CITY-STATE-FACTORY[' . __METHOD__ . ':' . __LINE__ . ']: City daemon state has changed from ' . $cityInstance->getPrintableState() . ' to ' . $stateInstance->getStateName() . '.');
64 // Once we have that state, set it in the city instance
65 $cityInstance->setStateInstance($stateInstance);
68 $cityInstance->updateCityData();
70 // For any purposes, return the state instance
71 return $stateInstance;