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 {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set part description
  35                 $this->setObjectDescription("Default news reader");
  36
  37                 // Create unique ID number
  38                 $this->generateUniqueId();
  39
  40                 // Clean up a little
  41                 $this->removeNumberFormaters();
  42                 $this->removeSystemArray();
  43         }
  44
  45         /**
  46          * Creates an instance of this reader by a provided request instance
  47          *
  48          * @param       $requestInstance        An instance of a Requestable class
  49          * @return      $readerInstance         An instance of this reader class
  50          */
  51         public final static function createDefaultNewsReader (Requestable $requestInstance) {
  52                 // Get a new instance
  53                 $readerInstance = new DefaultNewsReader();
  54
  55                 // Set request instance
  56                 $readerInstance->setRequestInstance($requestInstance);
  57
  58                 // Return prepared instance
  59                 return $readerInstance;
  60         }
  61
  62         /**
  63          * Initializes this reader class by pre-fetching news depending on "page"
  64          * (outside or login area), which amount of news and how much to skip
  65          *
  66          * @return      void
  67          */
  68         public function initializeReader () {
  69                 // TODO Need to implement this method
  70         }
  71 }
  72
  73 // [EOF]
  74 ?>