Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/willvincent/feeds
A simple Laravel service provider for including the SimplePie library.
https://github.com/willvincent/feeds
Last synced: 3 months ago
JSON representation
A simple Laravel service provider for including the SimplePie library.
- Host: GitHub
- URL: https://github.com/willvincent/feeds
- Owner: willvincent
- License: mit
- Created: 2015-02-17T07:23:00.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-03-14T16:29:23.000Z (8 months ago)
- Last Synced: 2024-07-26T15:49:12.842Z (4 months ago)
- Language: PHP
- Homepage:
- Size: 62.5 KB
- Stars: 308
- Watchers: 18
- Forks: 75
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Laravel Feeds
[](https://packagist.org/packages/willvincent/feeds)
[](https://insight.sensiolabs.com/projects/9098208d-abd1-44ea-af47-a0c42a01cb75)
[](https://packagist.org/packages/willvincent/feeds)
[](https://packagist.org/packages/willvincent/feeds) [](https://packagist.org/packages/willvincent/feeds) [](https://packagist.org/packages/willvincent/feeds)
A simple [Laravel 5/6/7/8/9/10](http://www.laravel.com/) service provider for including the [SimplePie](http://www.simplepie.org) library.
## Installation
The Laravel 5/6/7/8/9/10 Feeds Service Provider can be installed via [Composer](http://getcomposer.org) by requiring the
`willvincent/feeds` package in your project's `composer.json`.
```json
{
"require": {
"willvincent/feeds": "2.3.*"
}
}
```
## Configuration
> If you're using Laravel 5.5 or newer you may skip the next step.
To use the Feeds Service Provider, you must register the provider when bootstrapping your Laravel application.
Find the `providers` key in your `config/app.php` and register the Service Provider.
```php
'providers' => [
// ...
willvincent\Feeds\FeedsServiceProvider::class,
],
```
Find the `aliases` key in your `config/app.php` and register the Facade.
```php
'aliases' => [
// ...
'Feeds' => willvincent\Feeds\Facades\FeedsFacade::class,
],
```
## Usage
Run `php artisan vendor:publish --provider="willvincent\Feeds\FeedsServiceProvider"` to publish the default config file, edit caching setting withing the resulting `config/feeds.php` file as desired.
See [SimplePie Documentation](http://simplepie.org/wiki/) for full API usage documentation.
The make() accepts 3 paramaters, the first parameter is an array of feed URLs, the second parameter is the max number of items to be returned per feed, and while the third parameter is a boolean which you can set to force to read unless content type not a valid RSS.
```php
$feed = \Feeds::make('http://feed/url/goes/here');
```
###### Note: In Laravel 5 and newer, Facades must either be prefixed with a backslash, or brought into scope with a `use [facadeName]` declaration.
### Example controller method, and it's related view:
Controller:
```php
public function demo() {
$feed = \Feeds::make('http://blog.case.edu/news/feed.atom');
$data = array(
'title' => $feed->get_title(),
'permalink' => $feed->get_permalink(),
'items' => $feed->get_items(),
);
return View::make('feed', $data);
}
```
or Force to read unless content type not a valid RSS
```php
public function demo() {
$feed = \Feeds::make('http://blog.case.edu/news/feed.atom', true); // if RSS Feed has invalid mime types, force to read
$data = array(
'title' => $feed->get_title(),
'permalink' => $feed->get_permalink(),
'items' => $feed->get_items(),
);
return View::make('feed', $data);
}
```
### Multifeeds example controller method, and it's related view:
Controller:
```php
public function demo() {
$feed = \Feeds::make([
'http://blog.case.edu/news/feed.atom',
'http://tutorialslodge.com/feed'
], 5);
$data = array(
'title' => $feed->get_title(),
'permalink' => $feed->get_permalink(),
'items' => $feed->get_items(),
);
return View::make('feed', $data);
}
```
or Force to read unless content type not a valid RSS
```php
public function demo() {
$feed = \Feeds::make(['http://blog.case.edu/news/feed.atom',
'http://tutorialslodge.com/feed'
], 5, true); // if RSS Feed has invalid mime types, force to read
$data = array(
'title' => $feed->get_title(),
'permalink' => $feed->get_permalink(),
'items' => $feed->get_items(),
);
return View::make('feed', $data);
}
```
View:
```php
@extends('app')
@section('content')
@foreach ($items as $item)
{{ $item->get_title() }}
{{ $item->get_description() }}
Posted on {{ $item->get_date('j F Y | g:i a') }}
@endforeach
@endsection
```