3 * An general object factory
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
24 class ObjectFactory extends BaseFactory {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
34 // Set object description
35 $this->setObjectDescription("Simple generic object factory");
37 // Create unique ID number
38 $this->generateUniqueId();
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
46 * @param $className Name of the class we shall construct
47 * @return $objectInstance An instance of the requested object
48 * @throws ClassNotFoundException If the requested class was not found
49 * @throws EmptyVariableException If a variable is empty unexpectly
51 public final static function createObjectByName ($className) {
52 // First get an instance of this factory
53 $factoryInstance = new ObjectFactory();
55 // Is the class name valid and is the class there?
56 if (empty($className)) {
57 // Throw an exception here
58 throw new EmptyVariableException(array($factoryInstance, 'className'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
59 } elseif (!class_exists($className)) {
60 // Then throw an exception
61 throw new ClassNotFoundException(array($factoryInstance, $className), self::EXCEPTION_CLASS_NOT_FOUND);
64 // Then Prepare the eval() command
65 $eval = sprintf("\$objectInstance = %s::create%s();",
73 // Return the prepared instance
74 return $objectInstance;
78 * Creates an object by it's configured name
80 * @param $configEnttry Configuration entry to read
81 * @return $objectInstance An instance of the requested object
83 public final static function createObjectByConfiguredName ($configEntry) {
84 // Read the configuration entry
85 $className = FrameworkConfiguration::getInstance()->readConfig($configEntry);
87 // Send this to the other factory...
88 $objectInstance = self::createObjectByName($className);
90 // Return the instance
91 return $objectInstance;