]> git.mxchange.org Git - core.git/blob - inc/classes/main/factories/objects/class_ObjectFactory.php
action=status_problem excluded
[core.git] / 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, 2009 Core Developer Team
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          * Total objects generated
27          */
28         private static $total = 0;
29
30         /**
31          * Protected constructor
32          *
33          * @return      void
34          */
35         protected function __construct () {
36                 // Call parent constructor
37                 parent::__construct(__CLASS__);
38         }
39
40         /**
41          * Creates a new object given by the name or throws an exception if
42          * the class was not found. No parameters for the object are currently
43          * supported.
44          *
45          * @param       $className                      Name of the class we shall construct
46          * @param       $args                           Arguments in an indexed array
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
50          */
51         public final static function createObjectByName ($className, array $args=array()) {
52                 // First get an instance of this factory
53                 $factoryInstance = new ObjectFactory();
54
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);
62                 }
63
64                 // Create method name
65                 $methodName = sprintf("create%s",
66                         $className
67                 );
68
69                 // Run the user function
70                 $objectInstance = call_user_func_array(array($className, $methodName), $args);
71
72                 // Count generated objects up
73                 self::$total++;
74
75                 // Return the prepared instance
76                 return $objectInstance;
77         }
78
79         /**
80          * Creates an object by it's configured name
81          *
82          * @param       $configEnttry           Configuration entry to read
83          * @param       $args                           Arguments in an indexed array
84          * @return      $objectInstance         An instance of the requested object
85          */
86         public final static function createObjectByConfiguredName ($configEntry, array $args=array()) {
87                 // Read the configuration entry
88                 $className = FrameworkConfiguration::getInstance()->getConfigEntry($configEntry);
89
90                 // Send this to the other factory...
91                 $objectInstance = self::createObjectByName($className, $args);
92
93                 // Return the instance
94                 return $objectInstance;
95         }
96
97         /**
98          * Static getter for total object count
99          *
100          * @return      $total  Total amount of generated objects
101          */
102         public final static function getTotal () {
103                 return self::$total;
104         }
105 }
106
107 // [EOF]
108 ?>