inc/classes/main/factories/objects/class_ObjectFactory.php

   1 <?php
   2 /**
   3  * An general object factory
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 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 ObjectFactory extends BaseFactory {
  25         /**
  26          * Protected constructor
  27          *
  28          * @param       $className      Name of this class
  29          * @return      void
  30          */
  31         protected function __construct ($className = __CLASS__) {
  32                 // Call parent constructor
  33                 parent::__construct($className);
  34         }
  35
  36         /**
  37          * Creates a new object given by the name or throws an exception if
  38          * the class was not found. No parameters for the object are currently
  39          * supported.
  40          *
  41          * @param       $className                      Name of the class we shall construct
  42          * @param       $args                           Arguments in an indexed array
  43          * @return      $objectInstance         An instance of the requested object
  44          * @throws      NoClassException        If the requested class was not found
  45          * @throws      EmptyVariableException  If a variable is empty unexpectly
  46          */
  47         public static final function createObjectByName ($className, array $args=array()) {
  48                 // First get an instance of this factory
  49                 $factoryInstance = new ObjectFactory();
  50
  51                 // Is the class name valid and is the class there?
  52                 if (empty($className)) {
  53                         // Throw an exception here
  54                         throw new EmptyVariableException(array($factoryInstance, 'className'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  55                 } elseif (!class_exists($className)) {
  56                         // Then throw an exception
  57                         throw new NoClassException(array($factoryInstance, $className), self::EXCEPTION_CLASS_NOT_FOUND);
  58                 }
  59
  60                 // Create method name
  61                 $methodName = sprintf("create%s", $className);
  62
  63                 // Run the user function
  64                 $objectInstance = call_user_func_array(array($className, $methodName), $args);
  65
  66                 // Count this one up
  67                 self::countObject($className);
  68
  69                 // Return the prepared instance
  70                 return $objectInstance;
  71         }
  72
  73         /**
  74          * Creates an object by it's configured name
  75          *
  76          * @param       $configEnttry           Configuration entry to read
  77          * @param       $args                           Arguments in an indexed array
  78          * @return      $objectInstance         An instance of the requested object
  79          */
  80         public static final function createObjectByConfiguredName ($configEntry, array $args=array()) {
  81                 // Read the configuration entry
  82                 $className = FrameworkConfiguration::getSelfInstance()->getConfigEntry($configEntry);
  83
  84                 // Send this to the other factory...
  85                 $objectInstance = self::createObjectByName($className, $args);
  86
  87                 // Return the instance
  88                 return $objectInstance;
  89         }
  90 }
  91
  92 // [EOF]
  93 ?>