58 lines
1.9 KiB
PHP
58 lines
1.9 KiB
PHP
<?php
|
|
/**
|
|
* Nextcloud - News
|
|
*
|
|
* This file is licensed under the Affero General Public License version 3 or
|
|
* later. See the COPYING file.
|
|
*
|
|
* @author Alessandro Cosentino <cosenal@gmail.com>
|
|
* @author Bernhard Posselt <dev@bernhard-posselt.com>
|
|
* @copyright 2012 Alessandro Cosentino
|
|
* @copyright 2012-2014 Bernhard Posselt
|
|
*/
|
|
|
|
namespace OCA\News\Fetcher;
|
|
|
|
use FeedIo\Reader\ReadErrorException;
|
|
use OCA\News\Db\Feed;
|
|
use OCA\News\Db\Item;
|
|
|
|
interface IFeedFetcher
|
|
{
|
|
|
|
/**
|
|
* Fetch feed content.
|
|
*
|
|
* @param string $url remote url of the feed
|
|
* @param boolean $favicon if the favicon should also be fetched, defaults to true
|
|
* @param string|null $lastModified a last modified value from an http header defaults to false.
|
|
* If lastModified matches the http header from the feed no results are fetched
|
|
* @param bool $fullTextEnabled If true use a scraper to download the full article
|
|
* @param string|null $user if given, basic auth is set for this feed
|
|
* @param string|null $password if given, basic auth is set for this feed. Ignored if user is empty
|
|
*
|
|
* @return <Feed, Item[]> an array containing the new feed and its items, first
|
|
* element being the Feed and second element being an array of Items
|
|
*
|
|
* @throws ReadErrorException if the Feed-IO fetcher encounters a problem
|
|
*/
|
|
public function fetch(
|
|
string $url,
|
|
bool $favicon,
|
|
?string $lastModified,
|
|
bool $fullTextEnabled,
|
|
?string $user,
|
|
?string $password
|
|
): array;
|
|
|
|
/**
|
|
* Can a fetcher handle a feed.
|
|
*
|
|
* @param string $url the url that should be fetched
|
|
*
|
|
* @return boolean if the fetcher can handle the url. This fetcher will be
|
|
* used exclusively to fetch the feed and the items of the page
|
|
*/
|
|
public function canHandle(string $url): bool;
|
|
}
|