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