application/hub/main/factories/states/communicator/class_CommunicatorStateFactory.php

   1 <?php
   2 /**
   3  * A factory class for communicator states
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2014, 2015 Hub 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 CommunicatorStateFactory 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 an instance of a configurable communicator state and sets it in the
  37          * given communicator instance.
  38          *
  39          * @param       $stateName                              Name of the state
  40          * @param       $communicatorInstance   A Communicator class instance
  41          * @return      $stateInstance                  A Stateable class instance
  42          */
  43         public static final function createCommunicatorStateInstanceByName ($stateName, Communicator $communicatorInstance) {
  44                 // Then construct the class' configuraton entry
  45                 $className = 'communicator_' . $stateName . '_state_class';
  46
  47                 // Get a class from that configuration entry
  48                 $stateInstance = self::createObjectByConfiguredName($className, array($communicatorInstance));
  49
  50                 // Debug message
  51                 self::createDebugInstance(__CLASS__)->debugOutput('COMMUNICATOR-STATE-FACTORY[' . __METHOD__ . ':' . __LINE__ . ']: Communicator state has changed from ' . $communicatorInstance->getPrintableState() . ' to ' . $stateInstance->getStateName() . '.');
  52
  53                 // Once we have that state, set it in the communicator instance
  54                 $communicatorInstance->setStateInstance($stateInstance);
  55
  56                 // Update communicator data
  57                 $communicatorInstance->updateCommunicatorData();
  58
  59                 // For any purposes, return the state instance
  60                 return $stateInstance;
  61         }
  62 }
  63
  64 // [EOF]
  65 ?>