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          * @param       $class  Name of the real class (not BaseFactory)
  29          * @return      void
  30          */
  31         protected function __construct () {
  32                 // Call parent constructor
  33                 parent::__construct(__CLASS__);
  34
  35                 // Set object description
  36                 $this->setObjectDescription("Simple generic object factory");
  37         }
  38
  39         /**
  40          * Creates a new object given by the name or throws an exception if
  41          * the class was not found. No parameters for the object are currently
  42          * supported.
  43          *
  44          * @param       $className                              Name of the class we shall construct
  45          * @return      $objectInstance                 An instance of the requested object
  46          * @throws      ClassNotFoundException  If the requested class was not found
  47          * @throws      EmptyVariableException  If a variable is empty unexpectly
  48          */
  49         public final static function createObjectByName ($className) {
  50                 // First get an instance of this factory
  51                 $factoryInstance = new ObjectFactory();
  52
  53                 // Is the class name valid and is the class there?
  54                 if (empty($className)) {
  55                         // Throw an exception here
  56                         throw new EmptyVariableException(array($factoryInstance, 'className'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  57                 } elseif (!class_exists($className)) {
  58                         // Then throw an exception
  59                         throw new ClassNotFoundException($className, self::EXCEPTION_CLASS_NOT_FOUND);
  60                 }
  61
  62                 // Then Prepare the eval() command
  63                 $eval = sprintf("\$objectInstance = %s::create%s();",
  64                         $className,
  65                         $className
  66                 );
  67
  68                 // Run the command
  69                 eval($eval);
  70
  71                 // Return the prepared instance
  72                 return $objectInstance;
  73         }
  74 }
  75
  76 // [EOF]
  77 ?>