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.
7 * @author Roland Haeder <webmaster@ship-simu.org>
9 * @copyright Copyright(c) 2007, 2008 Roland Haeder, this is free software
10 * @license GNU GPL 3.0 or any newer version
11 * @link http://www.ship-simu.org
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.
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.
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/>.
26 class NewsDownloadFilter extends BaseFilter implements Filterable {
28 * Protected constructor
32 protected function __construct () {
33 // Call parent constructor
34 parent::__construct(__CLASS__);
36 // Set part description
37 $this->setObjectDescription("A filter for downloading news");
39 // Create unique ID number
40 $this->generateUniqueId();
44 * Creates an instance of this filter class
46 * @return $filterInstance An instance of this filter class
48 public final static function createNewsDownloadFilter () {
50 $filterInstance = new NewsDownloadFilter();
52 // Return the instance
53 return $filterInstance;
57 * Executes the filter with given request and response objects
59 * @param $requestInstance An instance of a class with an Requestable interface
60 * @param $responseInstance An instance of a class with an Responseable interface
63 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
64 // Get a news instance
65 $newsInstance = WebNewsFactory::createFactoryByRequest($requestInstance);
67 // Store the news instance in registry
68 Registry::getRegistry()->addInstance('news', $newsInstance);