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 * Total objects generated
28 private static $total = 0;
31 * Protected constructor
35 protected function __construct () {
36 // Call parent constructor
37 parent::__construct(__CLASS__);
39 // Set object description
40 $this->setObjectDescription("Simple generic object factory");
42 // Create unique ID number
43 $this->generateUniqueId();
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
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
57 public final static function createObjectByName ($className, array $args=array()) {
58 // First get an instance of this factory
59 $factoryInstance = new ObjectFactory();
61 // Is the class name valid and is the class there?
62 if (empty($className)) {
63 // Throw an exception here
64 throw new EmptyVariableException(array($factoryInstance, 'className'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
65 } elseif (!class_exists($className)) {
66 // Then throw an exception
67 throw new ClassNotFoundException(array($factoryInstance, $className), self::EXCEPTION_CLASS_NOT_FOUND);
70 // Then Prepare the call-back function
71 $callback = sprintf("%s::create%s",
76 // Run the user function
77 $objectInstance = call_user_func_array($callback, $args);
79 // Count generated objects up
82 // Return the prepared instance
83 return $objectInstance;
87 * Creates an object by it's configured name
89 * @param $configEnttry Configuration entry to read
90 * @param $args Arguments in an indexed array
91 * @return $objectInstance An instance of the requested object
93 public final static function createObjectByConfiguredName ($configEntry, array $args=array()) {
94 // Read the configuration entry
95 $className = FrameworkConfiguration::getInstance()->readConfig($configEntry);
97 // Send this to the other factory...
98 $objectInstance = self::createObjectByName($className, $args);
100 // Return the instance
101 return $objectInstance;
105 * Static getter for total object count
107 * @return $total Total amount of generated objects
109 public final static function getTotal () {