Renamed a lot more stuff from 'web' to 'html'.
[core.git] / inc / classes / main / factories / html / class_HtmlNewsFactory.php
1 <?php
2 /**
3  * A news factory for web pages
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.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 HtmlNewsFactory 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
40         /**
41          * Singleton getter for a special factory instance depending on the given
42          * request
43          *
44          * @param       $requestInstance        An instance of a request class
45          * @return      $factoryInstance        An instance of a HtmlNewsFactory class
46          */
47         public static final function createFactoryByRequest (Requestable $requestInstance) {
48                 // Set default news reader class
49                 $configEntry = 'news_reader_class';
50
51                 // Get "page"
52                 $page = $requestInstance->getRequestElement('page');
53
54                 // Is 'page' used?
55                 if (!empty($page)) {
56                         // Then add it
57                         $configEntry = sprintf('news_reader_%s_class', $page);
58
59                         // Get 'action'
60                         $action = $requestInstance->getRequestElement('action');
61
62                         // Is it also there?
63                         if (!empty($action)) {
64                                 // Then use both for config entry
65                                 $configEntry = sprintf('news_reader_%s_%s_class', $page, $action);
66                         } // END - if
67                 } // END - if
68
69                 // Get the news reader class name from config
70                 $className = $requestInstance->getConfigInstance()->getConfigEntry($configEntry);
71
72                 // Once we have that name, try to load initialize it
73                 $newsInstance = ObjectFactory::createObjectByName($className, array($requestInstance));
74
75                 // Initialize the reader
76                 $newsInstance->initializeReader();
77
78                 // Return the prepared factory instance
79                 return $newsInstance;
80         }
81 }
82
83 // [EOF]
84 ?>