feed io

进料

请使用php-feed-io/feed-io

重要的

feed-io现在拥有一个专门的组织来照顾其维护。请前往https://gi**thub*.com/php-feed-io/feed-io进行文档，问题，功能请求和错误报告。非常感谢迄今为止为使我感到骄傲的小图书馆做出feed-io的每个人。特别是@grotax和@smillerdev，没有这些旅程将无法继续。大家好！ ?

Feed-io是一个旨在消费和提供新闻提要的PHP库。它的特征：

• JSONFEED / ATOM / RSS读写支持
• 通过HTML标头馈送自动发现
• 命令行界面可发现和读取提要
• PSR-7响应生成具有准确的缓存标头
• HTTP标头在阅读供稿时支持以节省网络流量
• 检测格式（RSS / ATOM）时
• 外壳支持以处理音频内容之类的外部媒体
• 饲料徽标支持（RSS + ATOM）
• 符合PSR的记录
• 内容过滤以仅获取最新项目
• DateTime检测和转换
• 通用HTTP客户端面
• 与每个PSR-18兼容HTTP客户端集成。

笔记

此功能列表可能会被新版本的php-feed-io/feed-io所过时。

该库是高度扩展的，旨在适应许多情况，因此，如果您没有通过文档找到解决方案，请随时在讨论中询问。

安装

使用作曲家将feed-io添加到项目的要求中：

    composer require php-feed-io/feed-io

要求

Feed-IO 4需要PHP 7.1+，Feed-IO 5需要PHP 8.0+。所有版本都依赖于psr/log和任何符合PSR-18的HTTP客户端。要继续使用您可能需要php-http/guzzle7-adapter 。它暗示了记录的monolog 。独白并不是唯一适合处理feed-io日志的库，您可以使用任何符合PSR/日志的库。

用法

CLI

假设您使用Composer安装了Feed-io，可以使用其命令行客户端从终端读取feed：

./vendor/bin/feedio read http://*p*hp*.net/feed.atom

阅读

Feed-io旨在在互联网上阅读供稿并发布您自己的供稿。它的主要班级是Feedio：

 // create a simple FeedIo instance, e.g. with the Symfony HTTP Client
$ client = new \\ FeedIo \\ Adapter \\ Http \\ Client ( new Symfony \\ Component \\ HttpClient \\ HttplugClient ());
$ feedIo = \\ FeedIo \\FeedIo ( $ client );

// read a feed
$ result = $ feedIo -> read ( $ url );

// get title
$ feedTitle = $ result -> getFeed ()-> getTitle ();

// iterate through items
foreach ( $ result -> getFeed () as $ item ) {
    echo $ item -> getTitle ();
}

如果自上次食用feed以来只需要获取新项目，请使用结果的getItemsSince()方法：

 // read a feed and specify the `$modifiedSince` limit to fetch only items newer than this date
$ result = $ feedIo -> read ( $ url , $ feed , $ modifiedSince );

// iterate through new items
foreach ( $ result -> getItemsSince () as $ item ) {
    echo $ item -> getTitle ();
}

您还可以根据需要将几个过滤器混合以排除物品：

 // read a feed
$ result = $ feedIo -> read ( $ url , $ feed , $ modifiedSince );

// remove items older than `$modifiedSince`
$ since = new FeedIo \\ Filter \\ Since ( $ result -> getModifiedSince ());

// Your own filter
$ database = new Acme \\ Filter \\ Database ();

$ chain = new Chain ();
$ chain
    -> add ( $ since )
    -> add ( $ database );

// iterate through new items
foreach ( $ result -> getFilteredItems ( $ chain ) as $ item ) {
    echo $ item -> getTitle ();
}

为了节省带宽，Feed-IO估算下一次阅读feed并从中获取新项目时，它将是相关的。

 $ nextUpdate = $ result -> getNextUpdate ();
echo \" computed next update: { $ nextUpdate -> format (\\ DATE_ATOM )}\" ;

// you may need to access the statistics
$ updateStats = $ result -> getUpdateStats ();
echo \" average interval in seconds: { $ updateStats -> getAverageInterval ()}\" ;

Feed-io通过首先检测到Feed在过去7天内是否有效来计算下一个更新时间，如果没有，我们认为它是困倦的。 Sleepy Feed的下一个更新日期将同时设置为第二天。如果提要不困，我们使用平均间隔和中间间隔，将这些间隔添加到Feed的最后一个修改日期中，并将结果与当前时间进行比较。如果结果是将来，则将其作为下一个更新时间返回。如果将来没有一个，我们认为提要很快就会更新，因此下一个更新时间是从计算的那一小时后的一个小时。

请注意：可以通过Result::getNextUpdate()参数设置固定的昏昏欲睡和关闭以更新为更新的提要的延迟，请参见结果。

提要发现

网页可以参考其标题中的一个或多个提要，Feed-io提供了一种发现它们的方法：

 // create a simple FeedIo instance, e.g. with the Symfony HTTP Client
$ client = new \\ FeedIo \\ Adapter \\ Http \\ Client ( new Symfony \\ Component \\ HttpClient \\ HttplugClient ());
$ feedIo = \\ FeedIo \\FeedIo ( $ client );

$ feeds = $ feedIo -> discover ( $ url );

foreach ( $ feeds as $ feed ) {
    echo \" discovered feed : { $ feed }\" ;
}

或者，您可以使用feed-io的命令行：

./vendor/bin/feedio discover https://a-*webs*i*te.org

您将在输出中获得所有发现的供稿。

将对象格式化为XML流

 // build the feed
$ feed = new FeedIo \\ Feed ;
$ feed -> setTitle ( \' ... \' );

// convert it into Atom
$ atomString = $ feedIo -> toAtom ( $ feed );

// or ...
$ atomString = $ feedIo -> format ( $ feed , \' atom \' );

添加样式表

 $ feed = new FeedIo \\ Feed ;
$ feed -> setTitle ( \' ... \' );
$ styleSheet = new StyleSheet ( \' http://ur*l-of-t**he-xsl-stylesheet.xsl \' );
$ feed -> setStyleSheet ( $ styleSheet );

建立包括媒体在内的提要

 // build the feed
$ feed = new FeedIo \\ Feed ;
$ feed -> setTitle ( \' ... \' );

$ item = $ feed -> newItem ();

// add namespaces
$ feed -> setNS (
    \' itunes \' , //namespace
    \' http://www.*itu**nes.com/dtds/podcast-1.0.dtd \' //dtd for the namespace
        );
$ feed -> set ( \' itunes,title \' , \' Sample Title \' ); //OR any other element defined in the namespace.
$ item -> addElement ( \' itunes:category \' , \' Education \' );

// build the media
$ media = new \\ FeedIo \\ Feed \\ Item \\ Media
$ media -> setUrl ( \' http://your*d**omain.tld/medias/some-podcast.mp3 \' );
$ media -> setType ( \' audio/mpeg \' );

// add it to the item
$ item -> addMedia ( $ media );

$ feed -> add ( $ item );

用feed创建有效的PSR-7响应

您可以使用\\ feedio \\FeedIo\\FeedIo::getPsrResponse() \\FeedIo\\FeedInstance转换为PSR-7有效响应：

 $ feed = new \\ FeedIo \\ Feed ;

// feed the beast ...
$ item = new \\ FeedIo \\ Feed \\ Item ;
$ item -> set . . .
$ feed -> add ( $ item );

$ atomResponse = $ feedIo -> getPsrResponse ( $ feed , \' atom \' );

$ jsonResponse = $ feedIo -> getPsrResponse ( $ feed , \' json \' );

构建饲料实例

要创建一个新的feedio实例，您只需要注入两个依赖项：

• HTTP客户端实现Feedio \\ Adapter \\ ClientInterface。它可以是外部图书馆的包装器，例如Feedio \\ apapter \\ guzlezz
• PSR-3 Logger实现PSR \\ Log \\ Loggerinterface

 // first dependency : the HTTP client
// here we use Guzzle as a dependency for the client
$ guzzle = new GuzzleHttp \\ Client ();
// Guzzle is wrapped in this adapter which is a FeedIo\\Adapter\\ClientInterface  implementation
$ client = new FeedIo \\ Adapter \\ Guzzle \\ Client ( $ guzzle );

// second dependency : a PSR-3 logger
$ logger = new Psr \\ Log \\ NullLogger ();

// now create FeedIo\'s instance
$ feedIo = new FeedIo \\ FeedIo ( $ client , $ logger );

独白配置为标准输出的另一个示例：

 // create a simple FeedIo instance, e.g. with the Symfony HTTP Client
$ client = new \\ FeedIo \\ Adapter \\ Http \\ Client ( new Symfony \\ Component \\ HttpClient \\ HttplugClient ());
$ logger = new Monolog \\ Logger ( \' default \' , [ new Monolog \\ Handler \\ StreamHandler ( \' php://stdout \' )]);
$ feedIo = \\ FeedIo \\FeedIo ( $ client , $ logger );

注入自定义记录仪

您可以注入所需的任何记录器，只要它实现Psr\\Log\\LoggerInterface即可。独白确实可以，但这不是唯一的库：https：//packagist.org/providers/psr/persr/log-implementation

 use FeedIo \\ FeedIo ;
use FeedIo \\ Adapter \\ Guzzle \\ Client ;
use GuzzleHttp \\ Client as GuzzleClient ;
use Custom \\ Logger ;

$ client = new Client ( new GuzzleClient ());
$ logger = new Logger ();

$ feedIo = new FeedIo ( $ client , $ logger );

注入自定义HTTP客户端

由于6.0有一个通用的HTTP适配器，它包装了任何符合PST-18的HTTP客户端。

 use CustomPsr18 \\ Client as CustomClient ;

$ client = new Custom \\ Adapter \\ Http \\Client( new CustomClient ())
$ logger = new Psr \\ Log \\ NullLogger ();

$ feedIo = new FeedIo \\ FeedIo ( $ client , $ logger );

使用工厂配置饲料

该工厂已在Feed-IO 5.2中弃用，并在6.0中被删除。直接实例化立面并传递所需的HTTP客户端和Logger接口。

处理缺失的时区

有时，您必须消耗饲料，其中日期缺少时区。在某些用例中，您可能需要指定提要的时区以获得准确的价值，因此Feed-io为此提供了解决方法：

 $ feedIo -> getDateTimeBuilder ()-> setFeedTimezone ( new \\ DateTimeZone ( $ feedTimezone ));
$ result = $ feedIo -> read ( $ feedUrl );
$ feedIo -> getDateTimeBuilder ()-> resetFeedTimezone ();

在获取结果后，请不要忘记重置feedTimezone ，否则您最终会得到同一时区中的所有供稿。

由PHP风暴建造

Feed-io的大部分代码都是使用Jetbrains提供的PHP Storm撰写的。