framework/main/classes/factories/client/class_ClientFactory.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Factory\Client;
   4
   5 // Import framework stuff
   6 use CoreFramework\Factory\ObjectFactory;
   7 use CoreFramework\Registry\Registry;
   8
   9 /**
  10  * An object factory for clients
  11  *
  12  * @author              Roland Haeder <webmaster@shipsimu.org>
  13  * @version             0.0.0
  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
  17  *
  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.
  22  *
  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.
  27  *
  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/>.
  30  */
  31 class ClientFactory extends ObjectFactory {
  32         /**
  33          * Protected constructor
  34          *
  35          * @return      void
  36          */
  37         protected function __construct () {
  38                 // Call parent constructor
  39                 parent::__construct(__CLASS__);
  40         }
  41
  42         /**
  43          * Creates a client object for given protocol. This method uses the
  44          * registry pattern to cache those instances.
  45          *
  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
  49          */
  50         public static final function createClientByProtocolInstance (HandleableProtocol $protocolInstance, $socketResource = FALSE) {
  51                 // Default is NULL (to initialize variable)
  52                 $clientInstance = NULL;
  53
  54                 // Generate registry key
  55                 $registryKey = strtolower($protocolInstance->getProtocolName()) . '_client';
  56
  57                 // Is the key already in registry?
  58                 if (Registry::getRegistry()->instanceExists($registryKey)) {
  59                         // Then use that instance
  60                         $clientInstance = Registry::getRegistry()->getInstance($registryKey);
  61
  62                         // Set socket resource
  63                         $clientInstance->setSocketResource($socketResource);
  64                 } else {
  65                         // Generate object instance
  66                         $clientInstance = self::createObjectByConfiguredName($registryKey, array($socketResource));
  67
  68                         // Set it in registry for later re-use
  69                         Registry::getRegistry()->addInstance($registryKey, $clientInstance);
  70                 }
  71
  72                 // Return the prepared instance
  73                 return $clientInstance;
  74         }
  75
  76 }