Renamed a lot more stuff from 'web' to 'html'.
[core.git] / inc / classes / main / filter / news / class_NewsDownloadFilter.php
1 <?php
2 /**
3  * A pre-filter for downloading news from a source. This can be a XML feed or
4  * the local database. You *can* register this filter as post filter but for
5  * output on web pages it makes no sense.
6  *
7  * @author              Roland Haeder <webmaster@shipsimu.org>
8  * @version             0.0.0
9  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
10  * @license             GNU GPL 3.0 or any newer version
11  * @link                http://www.shipsimu.org
12  *
13  * This program is free software: you can redistribute it and/or modify
14  * it under the terms of the GNU General Public License as published by
15  * the Free Software Foundation, either version 3 of the License, or
16  * (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program. If not, see <http://www.gnu.org/licenses/>.
25  */
26 class NewsDownloadFilter extends BaseFilter implements Filterable {
27         /**
28          * Protected constructor
29          *
30          * @return      void
31          */
32         protected function __construct () {
33                 // Call parent constructor
34                 parent::__construct(__CLASS__);
35         }
36
37         /**
38          * Creates an instance of this filter class
39          *
40          * @return      $filterInstance                 An instance of this filter class
41          */
42         public static final function createNewsDownloadFilter () {
43                 // Get a new instance
44                 $filterInstance = new NewsDownloadFilter();
45
46                 // Return the instance
47                 return $filterInstance;
48         }
49
50         /**
51          * Executes the filter with given request and response objects
52          *
53          * @param       $requestInstance        An instance of a class with an Requestable interface
54          * @param       $responseInstance       An instance of a class with an Responseable interface
55          * @return      void
56          */
57         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
58                 // Get a news instance
59                 $newsInstance = HtmlNewsFactory::createFactoryByRequest($requestInstance);
60
61                 // Store the news instance in registry
62                 Registry::getRegistry()->addInstance('news', $newsInstance);
63         }
64 }
65
66 // [EOF]
67 ?>