arandilopez/laravel-feed-parser

Laravel and Lumen rss feed parser

v0.1.3 2016-09-14 20:55 UTC

README

Latest Stable Version Total Downloads Latest Unstable Version License

A Laravel and Lumen package for parse RSS Feeds using SimplePie.

Instalation

You can install this package with composer by typing in your console: composer require 'arandilopez/laravel-feed-parser:dev-master' or adding this at your project's composer.json.

"require": {
  "arandilopez/laravel-feed-parser": "0.1.*"
}

Configuration

Laravel 5.1 (Pending Test)

Register the FeedServiceProvider in your providers array in config/app.php in Laravel 5.1

'providers' => [
  // ...

  ArandiLopez\Feed\Providers\FeedServiceProvider::class,
],

Lumen 5.1

Register the LumenFeedServiceProvider in your bootstrap/app.php in Lumen 5.1

// $app->register(App\Providers\AppServiceProvider::class);
$app->register(ArandiLopez\Feed\Providers\LumenFeedServiceProvider::class);

In order to use the Facade Feed you have to uncomment this line:


$app->withFacades();

Environment Configuration

Laravel and Lumen use .env files for their configuration. To change defaults configuration of Feed Parser add this environment variables in your .env file:

  • FEED_CACHE_LIFE (Set cache lifetime. Expects an integer. Defaults 3600).
  • FEED_CACHE_ENABLED (Enable cache. Expects a boolean. Defaults true).

Cache location is set default to storage laravel path

Usage

Quick Lumen example


$app->get('/feed', function() {
  $myFeed = Feed::make('http://arandilopez.me/feed.xml');

  return response()->json($myFeed);
});

You can get the whole SimplePie instance by doing:

$myFeed = Feed::make('http://arandilopez.me/feed.xml');
$simplePieInstance = $myFeed->getRawFeederObject();

// do configs and whatever with the instance 

Check SimplePie's configuration and Docs at simplepie.org/wiki/

Contributing

Yes, please.

Any feedback, errors or features suggestions are welcome in the issues