feed-io 是一个 PHP 库,旨在使用和提供新闻提要。其特点:
该库具有高度可扩展性,旨在适应多种情况,因此,如果您在文档中找不到解决方案,请随时在讨论中提问。
使用 Composer 将 feed-io 添加到项目的需求中:
composer require debril/feed-io
feed-io | PHP |
---|---|
4.x | 7.1+ |
5.0 | 8.0+ |
6.0 | 8.1+ |
feed-io 4 需要 PHP 7.1+,feed-io 5 需要 PHP 8.0+。所有版本都依赖于psr/log
和任何符合 PSR-18 的 HTTP 客户端。要继续使用,您可能需要php-http/guzzle7-adapter
。它建议进行monolog
。 Monolog 不是唯一适合处理 feed-io 日志的库,您可以使用任何 PSR/Log 兼容的库。
假设您使用 Composer 安装了 feed-io,您可以使用其命令行客户端从终端读取 feed:
./vendor/bin/feedio read http://php.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 天内是否处于活动状态来计算下一次更新时间,如果不是,我们认为它处于休眠状态。昏昏欲睡的提要的下一次更新日期同时设置为第二天。如果 Feed 不困,我们将使用平均间隔和中值间隔,将这些间隔添加到 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-website.org
您将在输出中获得所有发现的提要。
// 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://url-of-the-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.itunes.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://yourdomain.tld/medias/some-podcast.mp3 ' );
$ media -> setType ( ' audio/mpeg ' );
// add it to the item
$ item -> addMedia ( $ media );
$ feed -> add ( $ item );
您可以使用FeedIoFeedIo::getPsrResponse()
将FeedIoFeedInstance
直接转换为 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 实例,您只需要注入两个依赖项:
// 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 FeedIoAdapterClientInterface 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 );
Monolog 配置为在标准输出上写入的另一个示例:
// 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 );
您可以注入任何您想要的 Logger,只要它实现PsrLogLoggerInterface
即可。 Monolog 可以,但它不是唯一的库:https://packagist.org/providers/psr/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 );
从 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 中删除。直接实例化 Facade 并传入所需的 HTTP 客户端和记录器接口。
有时您必须使用日期中缺少时区的提要。在某些用例中,您可能需要指定 feed 的时区才能获得准确的值,因此 feed-io 提供了一个解决方法:
$ feedIo -> getDateTimeBuilder ()-> setFeedTimezone ( new DateTimeZone ( $ feedTimezone ));
$ result = $ feedIo -> read ( $ feedUrl );
$ feedIo -> getDateTimeBuilder ()-> resetFeedTimezone ();
不要忘记在获取结果后重置feedTimezone
,否则您最终会得到位于同一时区的所有提要。
feed-io 的大部分代码是使用 Jetbrains 提供的 PHP Storm 编写的。