3 * An general object factory
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
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 * Total objects generated
28 private static $total = 0;
31 * Protected constructor
33 * @param $className Name of this class
36 protected function __construct ($className = __CLASS__) {
37 // Call parent constructor
38 parent::__construct($className);
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 * @param $args Arguments in an indexed array
48 * @return $objectInstance An instance of the requested object
49 * @throws NoClassException If the requested class was not found
50 * @throws EmptyVariableException If a variable is empty unexpectly
52 public static final function createObjectByName ($className, array $args=array()) {
53 // First get an instance of this factory
54 $factoryInstance = new ObjectFactory();
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 NoClassException(array($factoryInstance, $className), self::EXCEPTION_CLASS_NOT_FOUND);
66 $methodName = sprintf("create%s",
70 // Run the user function
71 $objectInstance = call_user_func_array(array($className, $methodName), $args);
73 // Count generated objects up
76 // Return the prepared instance
77 return $objectInstance;
81 * Creates an object by it's configured name
83 * @param $configEnttry Configuration entry to read
84 * @param $args Arguments in an indexed array
85 * @return $objectInstance An instance of the requested object
87 public static final function createObjectByConfiguredName ($configEntry, array $args=array()) {
88 // Read the configuration entry
89 $className = FrameworkConfiguration::getInstance()->getConfigEntry($configEntry);
91 // Send this to the other factory...
92 $objectInstance = self::createObjectByName($className, $args);
94 // Return the instance
95 return $objectInstance;
99 * Static getter for total object count
101 * @return $total Total amount of generated objects
103 public static final function getTotal () {