inc/classes/main/reader/class_DefaultNewsReader.php

   1 <?php
   2 /**
   3  * A default news reader class reads news from database layer
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class DefaultNewsReader extends BaseFrameworkSystem implements ReadableNews, Registerable {
  25         /**
  26          * Result set with news
  27          */
  28         private $resultInstance = null;
  29
  30         /**
  31          * Protected constructor
  32          *
  33          * @return      void
  34          */
  35         protected function __construct () {
  36                 // Call parent constructor
  37                 parent::__construct(__CLASS__);
  38
  39                 // Set part description
  40                 $this->setObjectDescription("Default news reader");
  41
  42                 // Create unique ID number
  43                 $this->generateUniqueId();
  44
  45                 // Clean up a little
  46                 $this->removeNumberFormaters();
  47                 $this->removeSystemArray();
  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 final static function createDefaultNewsReader (Requestable $requestInstance) {
  57                 // Get a new instance
  58                 $readerInstance = new DefaultNewsReader();
  59
  60                 // Set request instance
  61                 $readerInstance->setRequestInstance($requestInstance);
  62
  63                 // Return prepared instance
  64                 return $readerInstance;
  65         }
  66
  67         /**
  68          * Initializes this reader class by pre-fetching news depending on "page"
  69          * (outside or login area), which amount of news and how much to skip
  70          *
  71          * @return      void
  72          */
  73         public function initializeReader () {
  74                 // Get "page" for saving some calls
  75                 $page = $this->getRequestInstance()->getRequestElement('page');
  76
  77                 // First get a wrapper instance
  78                 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('news_db_wrapper_class');
  79
  80                 // Next create a searchable criteria instance
  81                 $criteriaInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
  82
  83                 // Add the page as criteria to it at lease
  84                 $criteriaInstance->addCriteria('page', $page);
  85
  86                 // Add limitation from config
  87                 $criteriaInstance->setLimit($this->getConfigInstance()->readConfig("news_{$page}_limit"));
  88
  89                 // Get a resultInstance back from the database
  90                 $resultInstance = $wrapperInstance->doSelectByCriteria($criteriaInstance);
  91
  92                 // Save that resultInstance in this class
  93                 $this->resultInstance = $resultInstance;
  94         }
  95 }
  96
  97 // [EOF]
  98 ?>