More code merged from ship-simu
[mailer.git] / inc / classes / main / factories / web / class_WebNewsFactory.php
1 <?php
2 /**
3  * A news factory for web pages
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 WebNewsFactory extends BaseFactory {
25         /**
26          * Instance of a request class
27          */
28         private $requestInstance = null;
29
30         /**
31          * Protected constructor
32          *
33          * @return      void
34          */
35         protected function __construct () {
36                 // Call parent constructor
37                 parent::__construct(__CLASS__);
38
39                 // Set part description
40                 $this->setObjectDescription("Factory for webpages with news");
41
42                 // Create unique ID number
43                 $this->generateUniqueId();
44         }
45
46         /**
47          * Singleton getter for a special factory instance depending on the given
48          * request
49          *
50          * @param       $requestInstance        An instance of a request class
51          * @return      $factoryInstance        An instance of a WebNewsFactory class
52          */
53         public final static function createFactoryByRequest (Requestable $requestInstance) {
54                 // Generate the new instance
55                 $factoryInstance = new WebNewsFactory();
56
57                 // Get the element name from configuration
58                 $element = FrameworkConfiguration::getInstance()->readConfig('app_selector_get');
59
60                 // Analyze the request, first get the Uni* application name (short one from URL)
61                 $appName = $requestInstance->getRequestElement($element);
62
63                 // Initialize some variables
64                 $className = "";
65                 $className2 = $appName;
66
67                 // Then construct the class name
68                 foreach (array("_", "-") as $exp) {
69                         $array = explode($exp, $className2);
70                         foreach ($array as $el) {
71                                 $className .= ucfirst(strtolower($el));
72                         }
73
74                         // Copy it back and clear the class name
75                         $className2 = $className;
76                         $className = "";
77                 }
78
79                 // After all is done, copy it back and add this class' name
80                 $className = $className2 . $factoryInstance->__toString();
81
82                 // Once we have that name, try to load initialize it
83                 $realFactoryInstance = ObjectFactory::createObjectByName($className);
84
85                 // And assign it with the factory
86                 $factoryInstance->setRealFactoryInstance($realFactoryInstance);
87
88                 // Remember the request we have used for later usage
89                 $factoryInstance->setRequestInstance($requestInstance);
90
91                 // Return the prepared factory instance
92                 return $factoryInstance;
93         }
94
95         /**
96          * Setter for the request instance
97          *
98          * @param       $requestInstance        An instance of a request object
99          * @return      void
100          */
101         public final function setRequestInstance (Requestable $requestInstance) {
102                 $this->requestInstance = $requestInstance;
103         }
104
105         /**
106          * Creates a new object instance and returns it
107          *
108          * @return      $newsInstance   An instance of a news object
109          */
110         public function createNewsObject () {
111                 // Ask the real factory class for doing this
112                 $newsInstance = $this->getRealFactoryInstance()->createNewObject($this->requestInstance);
113
114                 // And return it
115                 return $newsInstance;
116         }
117 }
118
119 // [EOF]
120 ?>