forensic / feed-parser
A fully integrated ATOM, RSS and RDF syndication feed parser
Installs: 2 184
Dependents: 0
Suggesters: 0
Security: 0
Stars: 10
Watchers: 0
Forks: 2
Open Issues: 12
Requires
- php: >=7.1
Requires (Dev)
- php-coveralls/php-coveralls: ^2.1
- phpunit/phpunit: ^7.3
- squizlabs/php_codesniffer: ^3.3
- dev-master
- v1.2.2
- v1.2.1
- v1.2.0
- v1.1.0
- v1.0.0
- dev-dependabot/npm_and_yarn/qs-6.5.3
- dev-dependabot/npm_and_yarn/decode-uri-component-0.2.2
- dev-dependabot/npm_and_yarn/semantic-release-19.0.3
- dev-dependabot/npm_and_yarn/path-parse-1.0.7
- dev-dependabot/npm_and_yarn/normalize-url-4.5.1
- dev-dependabot/npm_and_yarn/hosted-git-info-2.8.9
- dev-dependabot/npm_and_yarn/handlebars-4.7.7
- dev-dependabot/npm_and_yarn/ssri-6.0.2
- dev-dependabot/npm_and_yarn/y18n-3.2.2
- dev-dependabot/npm_and_yarn/ini-1.3.7
- dev-dependabot/npm_and_yarn/npm-registry-fetch-4.0.5
- dev-dependabot/npm_and_yarn/npm-6.14.6
This package is auto-updated.
Last update: 2025-04-11 03:09:06 UTC
README
PHP Feed Parser is a fully integrated web syndication feed parser. It can successfully parse all the three major syndication feeds which include RSS, ATOM & RDF feeds.
It produces clean, unified parse accross all the three supported feed types. It is configurable, lightweight, fully tested and allows one to parse feeds from three different sources that includes parsing from url, from file or from string.
Getting Started
Install via composer:
composer require forensic/feed-parser
Create an instance as shown below:
//include composer autoload.php require 'vendor/autoload.php'; //use the project's Parser module use Forensic\FeedParser\Parser; //create an instance $parser = new Parser(); //parse yahoo rss news feed $feed = $parser->parseFromURL('https://www.yahoo.com/news/rss/mostviewed'); //access feed properties echo $feed->type; //1 for RSS, 2 for ATOM, 3 for RDF echo $feed->title; echo $feed->link; echo $feed->lastUpdated; echo $feed->generator; echo $feed->description; echo $feed->image->src; .... //access items $items = $feed->items; foreach ($items as $item) { //access feed item properties echo $item->link; echo $item->content; echo $item->textContent; // the same as content, but all html tags are stripped out echo $item->createdAt; echo $item->lastUpdated; echo $item->category; echo $item->image->src; echo $item->image->title; ..... }
Export Feed as JSON
You can also export the parsed feed as json, as shown below. This can also help you view all properties that are accessible in the parsed feed.
//create an instance $parser = new Parser(); //parse yahoo rss news feed $feed = $parser->parseFromURL('https://www.yahoo.com/news/rss/mostviewed'); header('Content-Type: application/json'); //export whole feed echo $feed->toJSON(); //export a single item echo $feed->items[0]->toJSON();
Parser Options
The following configuration options can be passed in when creating an instance or set through the designated public methods:
//constructor signature new Parser( string $default_lang = 'en', bool $remove_styles = true, bool $remove_scripts = true );
-
default_lang:
This option sets the default feed language property to use should there be no language entry found in the xml document.
$parser = new Parser(); $parser->setDefaultLanguage('fr');
-
remove_styles:
This option states if stylings found in any feed item's content, should be stripped off. The stylings include html
style
element and attribute. Defaults to true.$parser = new Parser(); $parser->removeStyles(true);
-
remove_scripts:
This option states if any scripting found in any feed item's content, should be stripped off. Scripting includes html
script
element and event handleron-prefixed
element attributes such asonclick
. Defaults to true.$parser = new Parser(); $parser->removeScripts(true);
Testing FeedParser
To locally test or contribute to this project, You should have at least php 7.1, xDebug, composer and npm installed, then ollow the steps below:
Clone this repo:
git clone https://github.com/teclone/php-feed-parser && php-feed-parser
Install dependencies:
composer install && npm install
Run test:
vendor/bin/phpunit