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 編寫的。