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