framework/main/classes/filter/news/class_NewsDownloadFilter.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Filter\News;
   4
   5 // Import framework stuff
   6 use CoreFramework\Factory\News\HtmlNewsFactory;
   7 use CoreFramework\Filter\BaseFilter;
   8 use CoreFramework\Filter\Filterable;
   9 use CoreFramework\Registry\Registry;
  10 use CoreFramework\Request\Requestable;
  11 use CoreFramework\Response\Responseable;
  12
  13 /**
  14  * A pre-filter for downloading news from a source. This can be a XML feed or
  15  * the local database. You *can* register this filter as post filter but for
  16  * output on web pages it makes no sense.
  17  *
  18  * @author              Roland Haeder <webmaster@shipsimu.org>
  19  * @version             0.0.0
  20  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 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 NewsDownloadFilter extends BaseFilter implements Filterable {
  38         /**
  39          * Protected constructor
  40          *
  41          * @return      void
  42          */
  43         protected function __construct () {
  44                 // Call parent constructor
  45                 parent::__construct(__CLASS__);
  46         }
  47
  48         /**
  49          * Creates an instance of this filter class
  50          *
  51          * @return      $filterInstance                 An instance of this filter class
  52          */
  53         public static final function createNewsDownloadFilter () {
  54                 // Get a new instance
  55                 $filterInstance = new NewsDownloadFilter();
  56
  57                 // Return the instance
  58                 return $filterInstance;
  59         }
  60
  61         /**
  62          * Executes the filter with given request and response objects
  63          *
  64          * @param       $requestInstance        An instance of a class with an Requestable interface
  65          * @param       $responseInstance       An instance of a class with an Responseable interface
  66          * @return      void
  67          */
  68         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  69                 // Get a news instance
  70                 $newsInstance = HtmlNewsFactory::createFactoryByRequest($requestInstance);
  71
  72                 // Store the news instance in registry
  73                 Registry::getRegistry()->addInstance('news', $newsInstance);
  74         }
  75
  76 }