README

Kirby 3 插件，用于显示订阅源。

FeedReader 插件提供对订阅源元素的统一访问。订阅源可能是 RSS、Atom 或 JSON 类型，通过其 URL 访问。提供了一个代码片段和块蓝图作为起点。

入门

您可以通过以下方法之一安装此插件：

Composer
```
composer require adspectus/feedreader
```
手动

克隆此存储库或下载当前版本，并将至少 index.php 和 index.js 文件以及 lib、blueprints 和 snippets 目录提取到您的 Kirby 安装的新文件夹 site/plugins/k3-feedreader 中。

基本用法是导入 FeedReader 类并在您的模板或代码片段中的任何位置创建一个新的 FeedReader 对象。订阅源的 URL 必须作为第一个参数（也可以是唯一参数）给出。

use Adspectus\FeedReader\FeedReader;

$feed = new FeedReader('https://www.heise.de/security/rss/news.rdf');

如果 URL 有效且可以成功检索，则可以通过 FeedReader 对象的实例的各种方法访问订阅源的内容，该实例现在存储在 $feed 变量中（有关所有方法的完整描述，请参阅参考）。

如果在创建对象的过程中出现问题，错误信息将被保存，并通过 error() 方法访问。只需检查 error() 的返回值是否为空。如果不为空，错误将作为数组返回。因此

if (! empty($feed->error())) {
  dump($feed->error()); /* or var_dump($feed->error()) */
}

将显示错误。

如果您需要有关 FeedReader 对象的更多信息（无论是否有错误），您可以通过 debug() 方法将其转储。此方法返回 FeedReader 对象的所有属性作为数组。

dump($feed->debug()); /* or var_dump($feed->debug()) */

请参阅文档中的调试部分，了解如何扩展或限制此方法返回的信息量。

当然，只有在 Kirby 的全局调试选项设置为 true 时，才应该输出这两个方法的结果。否则，您可能会让您的网站访客看到奇怪的消息。

插件使用 Kirby 的缓存机制。您可以通过在 config.php 的 return 语句中设置键值对来禁用此功能：

`adspectus.feedreader.cache` => false

请参阅文档中的缓存部分，了解此插件中的缓存如何工作。

此插件附带一个块蓝图和相应的代码片段，以用于与 Kirby 的面板一起工作。请参阅文档中的扩展用法部分，了解如何使用和修改此蓝图和代码片段。

此插件已与各种订阅源进行了测试。然而，考虑到订阅源格式的变化，几乎不可能考虑到所有变化。如果您遇到一个与此插件不起作用的订阅源，请通过订阅源 URL 提交问题。当然，您也可以克隆此存储库并提供一个修复方案。