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