3 * A default news reader class reads news from database layer
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
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.
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.
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/>.
24 class DefaultNewsReader extends BaseFrameworkSystem implements ReadableNews, Registerable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
34 // Set part description
35 $this->setObjectDescription("Default news reader");
37 // Create unique ID number
38 $this->generateUniqueId();
41 $this->removeNumberFormaters();
42 $this->removeSystemArray();
46 * Creates an instance of this reader by a provided request instance
48 * @param $requestInstance An instance of a Requestable class
49 * @return $readerInstance An instance of this reader class
51 public final static function createDefaultNewsReader (Requestable $requestInstance) {
53 $readerInstance = new DefaultNewsReader();
55 // Set request instance
56 $readerInstance->setRequestInstance($requestInstance);
58 // Return prepared instance
59 return $readerInstance;
63 * Initializes this reader class by pre-fetching news depending on "page"
64 * (outside or login area), which amount of news and how much to skip
68 public function initializeReader () {
69 // Get "page" for saving some calls
70 $page = $this->getRequestInstance()->getRequestElement('page');
72 // First get a wrapper instance
73 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('news_db_wrapper_class');
75 // Next create a searchable criteria instance
76 $criteriaInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
78 // Add the page as criteria to it at lease
79 $criteriaInstance->addCriteria('page', $page);
81 // Add limitation from config
82 $criteriaInstance->setLimit($this->getConfigInstance()->readConfig("news_{$page}_limit"));
84 // Get a resultInstance back from the database
85 $resultInstance = $wrapperInstance->doSelectByCriteria($criteriaInstance);
87 // Save that resultInstance in this class
88 $this->setResultInstance($resultInstance);