3 * A factory class for peer states
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Hub Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.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 PeerStateFactory extends ObjectFactory {
26 * Static lookup table instance
28 private static $tableInstance = null;
31 * Protected constructor
35 protected function __construct () {
36 // Call parent constructor
37 parent::__construct(__CLASS__);
41 * Creates a peer state instance based on errorCode if no entry is found in the lookup table
42 * for the peer given in $packageData 'sender' element or it changes the state if it differs
45 * @param $errorCode The last error code
46 * @param $packageData Raw package data
47 * @return $stateInstance A Stateable class instance
49 public static final function createPeerStateInstanceByErrorCode ($errorCode, array $packageData) {
50 // So first we need our lookup table
51 $tableInstance = self::getTableInstance();
53 // Do we have an entry?
54 if ($tableInstance->isSenderNewPeer($packageData)) {
55 // Is a new peer so create the state instance based on error code, first we need a config entry
56 $configEntry = 'peer_state_' . $errorCode . '_class';
59 $stateInstance = ObjectFactory::createObjectByConfiguredName($configEntry);
61 // And register it with the lookup table
62 $tableInstance->registerPeerState($stateInstance, $packageData);
64 // It is a known peer, so we need to check if the state has changed
65 die(__METHOD__ . ': Lookup!' . "\n");
68 // For any purposes, return the state instance
69 return $stateInstance;
73 * Singleton getter for lookup table instances, kept public if we need this
74 * table somewhere else.
76 * @return $tableInstance An instance of a lookup table
78 public final static function getTableInstance () {
79 // Is the instance null?
80 if (is_null(self::$tableInstance)) {
82 self::$tableInstance = ObjectFactory::createObjectByConfiguredName('peer_state_lookup_table_class');
86 return self::$tableInstance;