loadController() is now more generic (TODO: check that all other apps works)
[core.git] / inc / classes / main / reader / class_DefaultNewsReader.php
1 <?php
2 /**
3  * A default news reader class reads news from database layer
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
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 DefaultNewsReader extends BaseFrameworkSystem implements ReadableNews, Registerable {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33
34                 // Clean up a little
35                 $this->removeNumberFormaters();
36                 $this->removeSystemArray();
37         }
38
39         /**
40          * Creates an instance of this reader by a provided request instance
41          *
42          * @param       $requestInstance        An instance of a Requestable class
43          * @return      $readerInstance         An instance of this reader class
44          */
45         public final static function createDefaultNewsReader (Requestable $requestInstance) {
46                 // Get a new instance
47                 $readerInstance = new DefaultNewsReader();
48
49                 // Set request instance
50                 $readerInstance->setRequestInstance($requestInstance);
51
52                 // Return prepared instance
53                 return $readerInstance;
54         }
55
56         /**
57          * Initializes this reader class by pre-fetching news depending on 'page'
58          * (outside or login area), which amount of news and how much to skip
59          *
60          * @return      void
61          */
62         public function initializeReader () {
63                 // Get 'page' for saving some calls
64                 $page = $this->getRequestInstance()->getRequestElement('page');
65
66                 // First get a wrapper instance
67                 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('news_db_wrapper_class');
68
69                 // Next create a searchable criteria instance
70                 $criteriaInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
71
72                 // Add the page as criteria to it at lease
73                 $criteriaInstance->addCriteria('page', $page);
74
75                 // Add limitation from config
76                 $criteriaInstance->setLimit($this->getConfigInstance()->readConfig('news_' . $page . '_limit'));
77
78                 // Get a resultInstance back from the database
79                 $resultInstance = $wrapperInstance->doSelectByCriteria($criteriaInstance);
80
81                 // Save that resultInstance in this class
82                 $this->setResultInstance($resultInstance);
83         }
84 }
85
86 // [EOF]
87 ?>