inc/main/classes/reader/class_DefaultNewsReader.php

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