]> git.mxchange.org Git - core.git/blob - framework/main/classes/reader/class_DefaultNewsReader.php
Continued:
[core.git] / framework / main / classes / reader / class_DefaultNewsReader.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Reader\News;
4
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;
12
13 /**
14  * A default news reader class reads news from database layer
15  *
16  * @author              Roland Haeder <webmaster@shipsimu.org>
17  * @version             0.0.0
18  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
19  * @license             GNU GPL 3.0 or any newer version
20  * @link                http://www.shipsimu.org
21  *
22  * This program is free software: you can redistribute it and/or modify
23  * it under the terms of the GNU General Public License as published by
24  * the Free Software Foundation, either version 3 of the License, or
25  * (at your option) any later version.
26  *
27  * This program is distributed in the hope that it will be useful,
28  * but WITHOUT ANY WARRANTY; without even the implied warranty of
29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
30  * GNU General Public License for more details.
31  *
32  * You should have received a copy of the GNU General Public License
33  * along with this program. If not, see <http://www.gnu.org/licenses/>.
34  */
35 class DefaultNewsReader extends BaseFrameworkSystem implements ReadableNews, Registerable {
36         /**
37          * Protected constructor
38          *
39          * @return      void
40          */
41         protected function __construct () {
42                 // Call parent constructor
43                 parent::__construct(__CLASS__);
44         }
45
46         /**
47          * Creates an instance of this reader by a provided request instance
48          *
49          * @param       $requestInstance        An instance of a Requestable class
50          * @return      $readerInstance         An instance of this reader class
51          */
52         public static final function createDefaultNewsReader (Requestable $requestInstance) {
53                 // Get a new instance
54                 $readerInstance = new DefaultNewsReader();
55
56                 // Return prepared instance
57                 return $readerInstance;
58         }
59
60         /**
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
63          *
64          * @return      void
65          */
66         public function initializeReader () {
67                 // Get 'command' for saving some calls
68                 $command = FrameworkBootstrap::getRequestInstance()->getRequestElement('command');
69
70                 // First get a wrapper instance
71                 $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('news_db_wrapper_class');
72
73                 // Next create a searchable criteria instance
74                 $criteriaInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
75
76                 // Add the page as criteria to it at lease
77                 $criteriaInstance->addCriteria('command', $command);
78
79                 // Add limitation from config
80                 $criteriaInstance->setConfiguredLimit('news_' . $command . '_limit');
81
82                 // Get a resultInstance back from the database
83                 $resultInstance = $wrapperInstance->doSelectByCriteria($criteriaInstance);
84
85                 // Save that resultInstance in this class
86                 $this->setResultInstance($resultInstance);
87         }
88
89 }