Code merge from latest Ship-Simu code
[mailer.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, 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          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33
34                 // Set object description
35                 $this->setObjectDescription("Simple generic object factory");
36
37                 // Create unique ID number
38                 $this->createUniqueID();
39         }
40
41         /**
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
44          * supported.
45          *
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
50          */
51         public final static function createObjectByName ($className) {
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                 // Then Prepare the eval() command
65                 $eval = sprintf("\$objectInstance = %s::create%s();",
66                         $className,
67                         $className
68                 );
69
70                 // Run the command
71                 eval($eval);
72
73                 // Return the prepared instance
74                 return $objectInstance;
75         }
76
77         /**
78          * Creates an object by it's configured name
79          *
80          * @param       $configEnttry                   Configuration entry to read
81          * @return      $objectInstance                 An instance of the requested object
82          */
83         public final static function createObjectByConfiguredName ($configEntry) {
84                 // Read the configuration entry
85                 $className = FrameworkConfiguration::getInstance()->readConfig($configEntry);
86
87                 // Send this to the other factory...
88                 $objectInstance = self::createObjectByName($className);
89
90                 // Return the instance
91                 return $objectInstance;
92         }
93 }
94
95 // [EOF]
96 ?>