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

   1 <?php
   2 /**
   3  * An general object factory
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.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          * Total objects generated
  27          */
  28         private static $total = 0;
  29
  30         /**
  31          * Protected constructor
  32          *
  33          * @return      void
  34          */
  35         protected function __construct () {
  36                 // Call parent constructor
  37                 parent::__construct(__CLASS__);
  38
  39                 // Set object description
  40                 $this->setObjectDescription("Simple generic object factory");
  41
  42                 // Create unique ID number
  43                 $this->generateUniqueId();
  44         }
  45
  46         /**
  47          * Creates a new object given by the name or throws an exception if
  48          * the class was not found. No parameters for the object are currently
  49          * supported.
  50          *
  51          * @param       $className                      Name of the class we shall construct
  52          * @param       $args                           Arguments in an indexed array
  53          * @return      $objectInstance         An instance of the requested object
  54          * @throws      ClassNotFoundException  If the requested class was not found
  55          * @throws      EmptyVariableException  If a variable is empty unexpectly
  56          */
  57         public final static function createObjectByName ($className, array $args=array()) {
  58                 // Is the class name valid and is the class there?
  59                 if (empty($className)) {
  60                         // First get an instance of this factory
  61                         $factoryInstance = new ObjectFactory();
  62
  63                         // Throw an exception here
  64                         throw new EmptyVariableException(array($factoryInstance, 'className'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  65                 } elseif (!class_exists($className)) {
  66                         // First get an instance of this factory
  67                         $factoryInstance = new ObjectFactory();
  68
  69                         // Then throw an exception
  70                         throw new ClassNotFoundException(array($factoryInstance, $className), self::EXCEPTION_CLASS_NOT_FOUND);
  71                 }
  72
  73                 // Then Prepare the call-back function
  74                 $callback = sprintf("%s::create%s",
  75                         $className,
  76                         $className
  77                 );
  78
  79                 // Run the user function
  80                 $objectInstance = call_user_func_array($callback, $args);
  81
  82                 // Count generated objects up
  83                 self::$total++;
  84
  85                 // Return the prepared instance
  86                 return $objectInstance;
  87         }
  88
  89         /**
  90          * Creates an object by it's configured name
  91          *
  92          * @param       $configEnttry           Configuration entry to read
  93          * @param       $args                           Arguments in an indexed array
  94          * @return      $objectInstance         An instance of the requested object
  95          */
  96         public final static function createObjectByConfiguredName ($configEntry, array $args=array()) {
  97                 // Read the configuration entry
  98                 $className = FrameworkConfiguration::getInstance()->readConfig($configEntry);
  99
 100                 // Send this to the other factory...
 101                 $objectInstance = self::createObjectByName($className, $args);
 102
 103                 // Return the instance
 104                 return $objectInstance;
 105         }
 106
 107         /**
 108          * Static getter for total object count
 109          *
 110          * @return      $total  Total amount of generated objects
 111          */
 112         public final static function getTotal () {
 113                 return self::$total;
 114         }
 115 }
 116
 117 // [EOF]
 118 ?>