533235580ae8ed668f51618474c2763289636e99
[core.git] / inc / main / classes / reader / class_ConsoleNewsReader.php
1 <?php
2 /**
3  * A console news reader class reads news from database layer
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 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 ConsoleNewsReader 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
35         /**
36          * Creates an instance of this reader by a provided request instance
37          *
38          * @param       $requestInstance        An instance of a Requestable class
39          * @return      $readerInstance         An instance of this reader class
40          */
41         public static final function createConsoleNewsReader (Requestable $requestInstance) {
42                 // Get a new instance
43                 $readerInstance = new ConsoleNewsReader();
44
45                 // Set request instance
46                 $readerInstance->setRequestInstance($requestInstance);
47
48                 // Return prepared instance
49                 return $readerInstance;
50         }
51
52         /**
53          * Initializes this reader class by pre-fetching news depending on 'command'
54          * (outside or login area), which amount of news and how much to skip
55          *
56          * @return      void
57          */
58         public function initializeReader () {
59                 // Get 'command' for saving some calls
60                 $command = $this->getRequestInstance()->getRequestElement('command');
61
62                 // First get a wrapper instance
63                 $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('news_db_wrapper_class');
64
65                 // Next create a searchable criteria instance
66                 $criteriaInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
67
68                 // Add the command as criteria to it at lease
69                 $criteriaInstance->addCriteria('command', $command);
70
71                 // Add limitation from config
72                 $criteriaInstance->setConfiguredLimit('news_' . $command . '_limit');
73
74                 // Get a resultInstance back from the database
75                 $resultInstance = $wrapperInstance->doSelectByCriteria($criteriaInstance);
76
77                 // Save that resultInstance in this class
78                 $this->setResultInstance($resultInstance);
79         }
80 }
81
82 // [EOF]
83 ?>