framework/main/classes/reader/class_ConsoleNewsReader.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Reader\News\Console;
   4
   5 // Import framework stuff
   6 use CoreFramework\Factory\Database\Wrapper\DatabaseWrapperFactory;
   7 use CoreFramework\Factory\ObjectFactory;
   8 use CoreFramework\Object\BaseFrameworkSystem;
   9 use CoreFramework\Reader\News\ReadableNews;
  10 use CoreFramework\Registry\Registerable;
  11 use CoreFramework\Request\Requestable;
  12
  13 /**
  14  * A console 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 - 2017 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 ConsoleNewsReader 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 createConsoleNewsReader (Requestable $requestInstance) {
  53                 // Get a new instance
  54                 $readerInstance = new ConsoleNewsReader();
  55
  56                 // Set request instance
  57                 $readerInstance->setRequestInstance($requestInstance);
  58
  59                 // Return prepared instance
  60                 return $readerInstance;
  61         }
  62
  63         /**
  64          * Initializes this reader class by pre-fetching news depending on 'command'
  65          * (outside or login area), which amount of news and how much to skip
  66          *
  67          * @return      void
  68          */
  69         public function initializeReader () {
  70                 // Get 'command' for saving some calls
  71                 $command = $this->getRequestInstance()->getRequestElement('command');
  72
  73                 // First get a wrapper instance
  74                 $wrapperInstance = DatabaseWrapperFactory::createWrapperByConfiguredName('news_db_wrapper_class');
  75
  76                 // Next create a searchable criteria instance
  77                 $criteriaInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
  78
  79                 // Add the command as criteria to it at lease
  80                 $criteriaInstance->addCriteria('command', $command);
  81
  82                 // Add limitation from config
  83                 $criteriaInstance->setConfiguredLimit('news_' . $command . '_limit');
  84
  85                 // Get a resultInstance back from the database
  86                 $resultInstance = $wrapperInstance->doSelectByCriteria($criteriaInstance);
  87
  88                 // Save that resultInstance in this class
  89                 $this->setResultInstance($resultInstance);
  90         }
  91
  92 }