teamzac/larapie

A Laravel-enhanced wrapper for the SimplePie library

v1.02 2024-07-19 14:49 UTC

Requires

• php: ^8.0|^8.1|^8.2
• facade/ignition-contracts: ^1.0
• illuminate/support: ^9.0|^10.0|^11.0
• nesbot/carbon: ^2.24|^3.7
• simplepie/simplepie: ^1.5

Requires (Dev)

• orchestra/testbench: 7.*|8.*|9.*
• phpunit/phpunit: ^8.5|^9.0

MIT

• Chad Janicek

• teamzac
• larapie

README

SimplePie is a popular and feature-rich PHP library for parsing RSS/Atom feeds, but I don't particularly like the API. This package is just a lightweight wrapper around SimplePie that provides a slightly different API along with Laravel support.

Installation

You can install the package via composer:

composer require teamzac/larapie

Usage

$feed = LaraPie::feed('https://your-feed-url/here.rss')->get();
$feed->items()->each(function($item) {
  echo $item->title;
});

The primary data types are Feed and Item.

Feed

The Feed class represents the RSS feed. It has an items() method which returns an Illuminate\Support\Collection instance of the feed items (TeamZac\LaraPie\Item). The Feed has the following read-only properties:

• title
• type
• links (TeamZac\LaraPie\Links)

Item

The Item class represents a single feed item. It has the following read-only properties:

• id - usually the URL
• title
• description
• content
• categories (Illuminate\Support\Collection of strings)
• authors (Illuminate\Support\Collection of TeamZac\LaraPie\Author)
• dates (Illuminate\Support\Collection of Carbon\Carbon)
• links (Illuminate\Support\Collection of strings)

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Chad Janicek
• Laravel Package Boilerplate

License

The MIT License (MIT). Please see License File for more information.