5a604a77981b4af97d7efde20dbc83634bf9c85b
[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
43         /**
44          * Singleton getter for a special factory instance depending on the given
45          * request
46          *
47          * @param       $requestInstance        An instance of a request class
48          * @return      $factoryInstance        An instance of a WebNewsFactory class
49          */
50         public final static function createFactoryByRequest (Requestable $requestInstance) {
51                 // Generate the new instance
52                 $factoryInstance = new WebNewsFactory();
53
54                 // Get the element name from configuration
55                 $element = FrameworkConfiguration::getInstance()->readConfig('app_selector_get');
56
57                 // Analyze the request, first get the Uni* application name (short one from URL)
58                 $appName = $requestInstance->getRequestElement($element);
59
60                 // Initialize some variables
61                 $className = "";
62                 $className2 = $appName;
63
64                 // Then construct the class name
65                 foreach (array("_", "-") as $exp) {
66                         $array = explode($exp, $className2);
67                         foreach ($array as $el) {
68                                 $className .= ucfirst(strtolower($el));
69                         }
70
71                         // Copy it back and clear the class name
72                         $className2 = $className;
73                         $className = "";
74                 }
75
76                 // After all is done, copy it back and add this class' name
77                 $className = $className2 . $factoryInstance->__toString();
78
79                 // Once we have that name, try to load initialize it
80                 $realFactoryInstance = ObjectFactory::createObjectByName($className);
81
82                 // And assign it with the factory
83                 $factoryInstance->setRealFactoryInstance($realFactoryInstance);
84
85                 // Remember the request we have used for later usage
86                 $factoryInstance->setRequestInstance($requestInstance);
87
88                 // Return the prepared factory instance
89                 return $factoryInstance;
90         }
91
92         /**
93          * Setter for the request instance
94          *
95          * @param       $requestInstance        An instance of a request object
96          * @return      void
97          */
98         public final function setRequestInstance (Requestable $requestInstance) {
99                 $this->requestInstance = $requestInstance;
100         }
101
102         /**
103          * Creates a new object instance and returns it
104          *
105          * @return      $newsInstance   An instance of a news object
106          */
107         public function createNewsObject () {
108                 // Ask the real factory class for doing this
109                 $newsInstance = $this->getRealFactoryInstance()->createNewObject($this->requestInstance);
110
111                 // And return it
112                 return $newsInstance;
113         }
114 }
115
116 // [EOF]
117 ?>