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

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Filter\News;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Factory\News\HtmlNewsFactory;
   7 use Org\Mxchange\CoreFramework\Filter\BaseFilter;
   8 use Org\Mxchange\CoreFramework\Filter\Filterable;
   9 use Org\Mxchange\CoreFramework\Registry\Registry;
  10 use Org\Mxchange\CoreFramework\Request\Requestable;
  11 use Org\Mxchange\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 <<<<<<< HEAD:framework/main/classes/filter/news/class_NewsDownloadFilter.php
  21  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  22 =======
  23  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
  24 >>>>>>> Some updates::inc/main/classes/filter/news/class_NewsDownloadFilter.php
  25  * @license             GNU GPL 3.0 or any newer version
  26  * @link                http://www.shipsimu.org
  27  *
  28  * This program is free software: you can redistribute it and/or modify
  29  * it under the terms of the GNU General Public License as published by
  30  * the Free Software Foundation, either version 3 of the License, or
  31  * (at your option) any later version.
  32  *
  33  * This program is distributed in the hope that it will be useful,
  34  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  35  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  36  * GNU General Public License for more details.
  37  *
  38  * You should have received a copy of the GNU General Public License
  39  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  40  */
  41 class NewsDownloadFilter extends BaseFilter implements Filterable {
  42         /**
  43          * Protected constructor
  44          *
  45          * @return      void
  46          */
  47         protected function __construct () {
  48                 // Call parent constructor
  49                 parent::__construct(__CLASS__);
  50         }
  51
  52         /**
  53          * Creates an instance of this filter class
  54          *
  55          * @return      $filterInstance                 An instance of this filter class
  56          */
  57         public static final function createNewsDownloadFilter () {
  58                 // Get a new instance
  59                 $filterInstance = new NewsDownloadFilter();
  60
  61                 // Return the instance
  62                 return $filterInstance;
  63         }
  64
  65         /**
  66          * Executes the filter with given request and response objects
  67          *
  68          * @param       $requestInstance        An instance of a class with an Requestable interface
  69          * @param       $responseInstance       An instance of a class with an Responseable interface
  70          * @return      void
  71          */
  72         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  73                 // Get a news instance
  74                 $newsInstance = HtmlNewsFactory::createFactoryByRequest($requestInstance);
  75
  76                 // Store the news instance in registry
  77                 Registry::getRegistry()->addInstance('news', $newsInstance);
  78         }
  79
  80 }