diff options
Diffstat (limited to 'lib/Fetcher/IFeedFetcher.php')
| -rw-r--r-- | lib/Fetcher/IFeedFetcher.php | 46 |
1 files changed, 24 insertions, 22 deletions
diff --git a/lib/Fetcher/IFeedFetcher.php b/lib/Fetcher/IFeedFetcher.php index 14a392698..c96bd315b 100644 --- a/lib/Fetcher/IFeedFetcher.php +++ b/lib/Fetcher/IFeedFetcher.php @@ -17,37 +17,39 @@ interface IFeedFetcher { /** - * @param string $url remote url of the feed - * @param boolean $getFavicon if the favicon should also be fetched, - * defaults to true - * @param string $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 string $etag an etag from an http header. - * If lastModified matches the - * http header from the feed no - * results are fetched - * @param bool fullTextEnabled if true tells the fetcher to enhance the - * articles by fetching custom enhanced content - * @param string $basicAuthUser if given, basic auth is set for this feed - * @param string $basicAuthPassword if given, basic auth is set for this - * feed. Ignored if user is null or an - * empty string + * Fetch feed content. + * + * @param string $url remote url of the feed + * @param boolean $getFavicon if the favicon should also be fetched, defaults to true + * @param string $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 string $etag an etag from an http header. + * If lastModified matches the http header from the feed no results are fetched + * @param bool $fullTextEnabled if true tells the fetcher to enhance the articles by fetching more content + * @param string $basicAuthUser if given, basic auth is set for this feed + * @param string $basicAuthPassword if given, basic auth is set for this feed. Ignored if user is empty + * * @throws FetcherException if the fetcher encounters a problem * @return array an array containing the new feed and its items, first * element being the Feed and second element being an array of Items */ - function fetch($url, $getFavicon=true, $lastModified=null, $etag=null, - $fullTextEnabled=false, $basicAuthUser=null, - $basicAuthPassword=null + public function fetch( + $url, + $getFavicon = true, + $lastModified = null, + $etag = null, + $fullTextEnabled = false, + $basicAuthUser = null, + $basicAuthPassword = null ); /** + * 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 */ - function canHandle($url); - + public function canHandle($url); } |