3 namespace CoreFramework\Factory\Client;
5 // Import framework stuff
6 use CoreFramework\Factory\ObjectFactory;
7 use CoreFramework\Registry\Registry;
10 * An object factory for clients
12 * @author Roland Haeder <webmaster@shipsimu.org>
14 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
15 * @license GNU GPL 3.0 or any newer version
16 * @link http://www.shipsimu.org
18 * This program is free software: you can redistribute it and/or modify
19 * it under the terms of the GNU General Public License as published by
20 * the Free Software Foundation, either version 3 of the License, or
21 * (at your option) any later version.
23 * This program is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
28 * You should have received a copy of the GNU General Public License
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 class ClientFactory extends ObjectFactory {
33 * Protected constructor
37 protected function __construct () {
38 // Call parent constructor
39 parent::__construct(__CLASS__);
43 * Creates a client object for given protocol. This method uses the
44 * registry pattern to cache those instances.
46 * @param $protocolInstance An instance of a HandleableProtocol class to create a client object for (e.g. 'http' for a HTTP/1.1 client)
47 * @param $socketResource A valid socket resource (optional)
48 * @return $clientInstance An instance of the requested client
50 public static final function createClientByProtocolInstance (HandleableProtocol $protocolInstance, $socketResource = false) {
51 // Default is NULL (to initialize variable)
52 $clientInstance = NULL;
54 // Generate registry key
55 $registryKey = strtolower($protocolInstance->getProtocolName()) . '_client';
57 // Is the key already in registry?
58 if (Registry::getRegistry()->instanceExists($registryKey)) {
59 // Then use that instance
60 $clientInstance = Registry::getRegistry()->getInstance($registryKey);
62 // Set socket resource
63 $clientInstance->setSocketResource($socketResource);
65 // Generate object instance
66 $clientInstance = self::createObjectByConfiguredName($registryKey, array($socketResource));
68 // Set it in registry for later re-use
69 Registry::getRegistry()->addInstance($registryKey, $clientInstance);
72 // Return the prepared instance
73 return $clientInstance;