Code sync from ship-simu code (all class config entries must end with _class!)
[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                 // Get the news reader class name from config
55                 $className = $requestInstance->getConfigInstance()->readConfig('news_reader_class');
56
57                 // Once we have that name, try to load initialize it
58                 $newsInstance = ObjectFactory::createObjectByName($className, array($requestInstance));
59
60                 // Initialize the reader
61                 $newsInstance->initializeReader();
62
63                 // Return the prepared factory instance
64                 return $newsInstance;
65         }
66 }
67
68 // [EOF]
69 ?>