3 namespace Org\Mxchange\CoreFramework\Reader\News\Console;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
7 use Org\Mxchange\CoreFramework\Factory\Database\Frontend\DatabaseFrontendFactory;
8 use Org\Mxchange\CoreFramework\Factory\Object\ObjectFactory;
9 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
10 use Org\Mxchange\CoreFramework\Reader\News\ReadableNews;
11 use Org\Mxchange\CoreFramework\Registry\Registerable;
12 use Org\Mxchange\CoreFramework\Request\Requestable;
13 use Org\Mxchange\CoreFramework\Traits\Result\Search\SearchableResultTrait;
16 * A console news reader class reads news from database layer
18 * @author Roland Haeder <webmaster@shipsimu.org>
20 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2022 Core Developer Team
21 * @license GNU GPL 3.0 or any newer version
22 * @link http://www.shipsimu.org
24 * This program is free software: you can redistribute it and/or modify
25 * it under the terms of the GNU General Public License as published by
26 * the Free Software Foundation, either version 3 of the License, or
27 * (at your option) any later version.
29 * This program is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU General Public License for more details.
34 * You should have received a copy of the GNU General Public License
35 * along with this program. If not, see <http://www.gnu.org/licenses/>.
37 class ConsoleNewsReader extends BaseFrameworkSystem implements ReadableNews, Registerable {
39 use SearchableResultTrait;
42 * Protected constructor
46 private function __construct () {
47 // Call parent constructor
48 parent::__construct(__CLASS__);
52 * Creates an instance of this reader by a provided request instance
54 * @param $requestInstance An instance of a Requestable class
55 * @return $readerInstance An instance of this reader class
57 public static final function createConsoleNewsReader (Requestable $requestInstance) {
59 $readerInstance = new ConsoleNewsReader();
61 // Return prepared instance
62 return $readerInstance;
66 * Initializes this reader class by pre-fetching news depending on 'command'
67 * (outside or login area), which amount of news and how much to skip
71 public function initializeReader () {
72 // Get 'command' for saving some calls
73 $command = FrameworkBootstrap::getRequestInstance()->getRequestElement('command');
75 // First get a frontend instance
76 $frontendInstance = DatabaseFrontendFactory::createFrontendByConfiguredName('news_db_frontend_class');
78 // Next create a searchable criteria instance
79 $criteriaInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
81 // Add the command as criteria to it at lease
82 $criteriaInstance->addCriteria('command', $command);
84 // Add limitation from config
85 $criteriaInstance->setConfiguredLimit('news_' . $command . '_limit');
87 // Get a resultInstance back from the database
88 $resultInstance = $frontendInstance->doSelectByCriteria($criteriaInstance);
90 // Save that resultInstance in this class
91 $this->setResultInstance($resultInstance);