3 namespace CoreFramework\Reader\News;
5 // Import framework stuff
6 use CoreFramework\Registry\Registerable;
9 * A console news reader class reads news from database layer
11 * @author Roland Haeder <webmaster@shipsimu.org>
13 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
14 * @license GNU GPL 3.0 or any newer version
15 * @link http://www.shipsimu.org
17 * This program is free software: you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation, either version 3 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 class ConsoleNewsReader extends BaseFrameworkSystem implements ReadableNews, Registerable {
32 * Protected constructor
36 protected function __construct () {
37 // Call parent constructor
38 parent::__construct(__CLASS__);
42 * Creates an instance of this reader by a provided request instance
44 * @param $requestInstance An instance of a Requestable class
45 * @return $readerInstance An instance of this reader class
47 public static final function createConsoleNewsReader (Requestable $requestInstance) {
49 $readerInstance = new ConsoleNewsReader();
51 // Set request instance
52 $readerInstance->setRequestInstance($requestInstance);
54 // Return prepared instance
55 return $readerInstance;
59 * Initializes this reader class by pre-fetching news depending on 'command'
60 * (outside or login area), which amount of news and how much to skip
64 public function initializeReader () {
65 // Get 'command' for saving some calls
66 $command = $this->getRequestInstance()->getRequestElement('command');
68 // First get a wrapper instance
69 $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('news_db_wrapper_class');
71 // Next create a searchable criteria instance
72 $criteriaInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
74 // Add the command as criteria to it at lease
75 $criteriaInstance->addCriteria('command', $command);
77 // Add limitation from config
78 $criteriaInstance->setConfiguredLimit('news_' . $command . '_limit');
80 // Get a resultInstance back from the database
81 $resultInstance = $wrapperInstance->doSelectByCriteria($criteriaInstance);
83 // Save that resultInstance in this class
84 $this->setResultInstance($resultInstance);