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          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set object description
  35                 $this->setObjectDescription("Simple generic object factory");
  36
  37                 // Create unique ID number
  38                 $this->generateUniqueId();
  39         }
  40
  41         /**
  42          * Creates a new object given by the name or throws an exception if
  43          * the class was not found. No parameters for the object are currently
  44          * supported.
  45          *
  46          * @param       $className                      Name of the class we shall construct
  47          * @param       $args                           Arguments in an indexed array
  48          * @return      $objectInstance         An instance of the requested object
  49          * @throws      ClassNotFoundException  If the requested class was not found
  50          * @throws      EmptyVariableException  If a variable is empty unexpectly
  51          */
  52         public final static function createObjectByName ($className, array $args=array()) {
  53                 // First get an instance of this factory
  54                 $factoryInstance = new ObjectFactory();
  55
  56                 // Is the class name valid and is the class there?
  57                 if (empty($className)) {
  58                         // Throw an exception here
  59                         throw new EmptyVariableException(array($factoryInstance, 'className'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  60                 } elseif (!class_exists($className)) {
  61                         // Then throw an exception
  62                         throw new ClassNotFoundException(array($factoryInstance, $className), self::EXCEPTION_CLASS_NOT_FOUND);
  63                 }
  64
  65                 // Then Prepare the call-back function
  66                 $callback = sprintf("%s::create%s",
  67                         $className,
  68                         $className
  69                 );
  70
  71                 // Run the user function
  72                 $objectInstance = call_user_func_array($callback, $args);
  73
  74                 // Return the prepared instance
  75                 return $objectInstance;
  76         }
  77
  78         /**
  79          * Creates an object by it's configured name
  80          *
  81          * @param       $configEnttry           Configuration entry to read
  82          * @param       $args                           Arguments in an indexed array
  83          * @return      $objectInstance         An instance of the requested object
  84          */
  85         public final static function createObjectByConfiguredName ($configEntry, array $args=array()) {
  86                 // Read the configuration entry
  87                 $className = FrameworkConfiguration::getInstance()->readConfig($configEntry);
  88
  89                 // Send this to the other factory...
  90                 $objectInstance = self::createObjectByName($className, $args);
  91
  92                 // Return the instance
  93                 return $objectInstance;
  94         }
  95 }
  96
  97 // [EOF]
  98 ?>