Renamed Registry -> GenericRegistry to make it clear that this registry does
[core.git] / inc / main / classes / factories / client / class_ClientFactory.php
1 <?php
2 /**
3  * An object factory for clients
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.org
10  *
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.
15  *
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.
20  *
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/>.
23  */
24 class ClientFactory extends ObjectFactory {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33         }
34
35         /**
36          * Creates a client object for given protocol. This method uses the
37          * registry pattern to cache those instances.
38          *
39          * @param       $protocolInstance       An instance of a HandleableProtocol class to create a client object for (e.g. 'http' for a HTTP/1.1 client)
40          * @param       $socketResource         A valid socket resource (optional)
41          * @return      $clientInstance         An instance of the requested client
42          */
43         public static final function createClientByProtocolInstance (HandleableProtocol $protocolInstance, $socketResource = FALSE) {
44                 // Default is NULL (to initialize variable)
45                 $clientInstance = NULL;
46
47                 // Generate registry key
48                 $registryKey = strtolower($protocolInstance->getProtocolName()) . '_client';
49
50                 // Is the key already in registry?
51                 if (GenericRegistry::getRegistry()->instanceExists($registryKey)) {
52                         // Then use that instance
53                         $clientInstance = GenericRegistry::getRegistry()->getInstance($registryKey);
54
55                         // Set socket resource
56                         $clientInstance->setSocketResource($socketResource);
57                 } else {
58                         // Generate object instance
59                         $clientInstance = self::createObjectByConfiguredName($registryKey, array($socketResource));
60
61                         // Set it in registry for later re-use
62                         Registry::getRegistry()->addInstance($registryKey, $clientInstance);
63                 }
64
65                 // Return the prepared instance
66                 return $clientInstance;
67         }
68
69 }