framework/main/classes/reader/class_ConsoleNewsReader.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Reader\News\Console;
   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\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;
  14
  15 /**
  16  * A console news reader class reads news from database layer
  17  *
  18  * @author              Roland Haeder <webmaster@shipsimu.org>
  19  * @version             0.0.0
  20  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
  21  * @license             GNU GPL 3.0 or any newer version
  22  * @link                http://www.shipsimu.org
  23  *
  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.
  28  *
  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.
  33  *
  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/>.
  36  */
  37 class ConsoleNewsReader extends BaseFrameworkSystem implements ReadableNews, Registerable {
  38         // Load traits
  39         use SearchableResultTrait;
  40
  41         /**
  42          * Protected constructor
  43          *
  44          * @return      void
  45          */
  46         private function __construct () {
  47                 // Call parent constructor
  48                 parent::__construct(__CLASS__);
  49         }
  50
  51         /**
  52          * Creates an instance of this reader by a provided request instance
  53          *
  54          * @param       $requestInstance        An instance of a Requestable class
  55          * @return      $readerInstance         An instance of this reader class
  56          */
  57         public static final function createConsoleNewsReader (Requestable $requestInstance) {
  58                 // Get a new instance
  59                 $readerInstance = new ConsoleNewsReader();
  60
  61                 // Return prepared instance
  62                 return $readerInstance;
  63         }
  64
  65         /**
  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
  68          *
  69          * @return      void
  70          */
  71         public function initializeReader () {
  72                 // Get 'command' for saving some calls
  73                 $command = FrameworkBootstrap::getRequestInstance()->getRequestElement('command');
  74
  75                 // First get a frontend instance
  76                 $frontendInstance = DatabaseFrontendFactory::createFrontendByConfiguredName('news_db_frontend_class');
  77
  78                 // Next create a searchable criteria instance
  79                 $criteriaInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
  80
  81                 // Add the command as criteria to it at lease
  82                 $criteriaInstance->addCriteria('command', $command);
  83
  84                 // Add limitation from config
  85                 $criteriaInstance->setConfiguredLimit('news_' . $command . '_limit');
  86
  87                 // Get a resultInstance back from the database
  88                 $resultInstance = $frontendInstance->doSelectByCriteria($criteriaInstance);
  89
  90                 // Save that resultInstance in this class
  91                 $this->setResultInstance($resultInstance);
  92         }
  93
  94 }