Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/suin/php-rss-writer
📦 Yet another simple RSS writer library for PHP 5.4 or later. This library can also be used to publish Podcasts.
https://github.com/suin/php-rss-writer
Last synced: about 2 months ago
JSON representation
📦 Yet another simple RSS writer library for PHP 5.4 or later. This library can also be used to publish Podcasts.
- Host: GitHub
- URL: https://github.com/suin/php-rss-writer
- Owner: suin
- Created: 2012-08-22T16:53:44.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2022-10-28T18:06:55.000Z (almost 2 years ago)
- Last Synced: 2024-05-18T19:02:05.255Z (4 months ago)
- Language: PHP
- Homepage:
- Size: 68.4 KB
- Stars: 265
- Watchers: 22
- Forks: 62
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# \Suin\RSSWriter
`\Suin\RSSWriter` is yet another simple RSS writer library for PHP 5.4 or later. This component is Licensed under MIT license.
This library can also be used to publish Podcasts.
[](https://packagist.org/packages/suin/php-rss-writer)
[](https://packagist.org/packages/suin/php-rss-writer)
[](https://packagist.org/packages/suin/php-rss-writer)
[](https://packagist.org/packages/suin/php-rss-writer)
[](https://travis-ci.org/suin/php-rss-writer)
[](https://www.codacy.com/app/suinyeze/php-rss-writer)
## Quick demo
```php
$feed = new Feed();
$channel = new Channel();
$channel
->title('Channel Title')
->description('Channel Description')
->url('http://blog.example.com')
->feedUrl('http://blog.example.com/rss')
->language('en-US')
->copyright('Copyright 2012, Foo Bar')
->pubDate(strtotime('Tue, 21 Aug 2012 19:50:37 +0900'))
->lastBuildDate(strtotime('Tue, 21 Aug 2012 19:50:37 +0900'))
->ttl(60)
->pubsubhubbub('http://example.com/feed.xml', 'http://pubsubhubbub.appspot.com') // This is optional. Specify PubSubHubbub discovery if you want.
->appendTo($feed);
// Blog item
$item = new Item();
$item
->title('Blog Entry Title')
->description('
Blog body')
->contentEncoded('Blog body')
->url('http://blog.example.com/2012/08/21/blog-entry/')
->author('John Smith')
->pubDate(strtotime('Tue, 21 Aug 2012 19:50:37 +0900'))
->guid('http://blog.example.com/2012/08/21/blog-entry/', true)
->preferCdata(true) // By this, title and description become CDATA wrapped HTML.
->appendTo($channel);
// Podcast item
$item = new Item();
$item
->title('Some Podcast Entry')
->description('
Podcast body')
->url('http://podcast.example.com/2012/08/21/podcast-entry/')
->enclosure('http://podcast.example.com/2012/08/21/podcast.mp3', 4889, 'audio/mpeg')
->appendTo($channel);
echo $feed; // or echo $feed->render();
```
Output:
```xml
Channel Title
http://blog.example.com
Channel Description
en-US
Copyright 2012, Foo Bar
Tue, 21 Aug 2012 10:50:37 +0000
Tue, 21 Aug 2012 10:50:37 +0000
60
http://blog.example.com/2012/08/21/blog-entry/
Blog body]]>
Blog body]]>
http://blog.example.com/2012/08/21/blog-entry/
Tue, 21 Aug 2012 10:50:37 +0000
John Smith
Some Podcast Entry
http://podcast.example.com/2012/08/21/podcast-entry/
<div>Podcast body</div>
```
## Installation
### Easy installation
You can install directly via [Composer](https://getcomposer.org/):
```bash
$ composer require suin/php-rss-writer
```
### Manual installation
Add the following code to your `composer.json` file:
```json
{
"require": {
"suin/php-rss-writer": ">=1.0"
}
}
```
...and run composer to install it:
```bash
$ composer install
```
Finally, include `vendor/autoload.php` in your product:
```php
require_once 'vendor/autoload.php';
```
## How to use
The [`examples`](examples) directory contains usage examples for RSSWriter.
If you want to know APIs, please see [`FeedInterface`](src/Suin/RSSWriter/FeedInterface.php), [`ChannelInterface`](src/Suin/RSSWriter/ChannelInterface.php) and [`ItemInterface`](src/Suin/RSSWriter/ItemInterface.php).
## How to Test
```sh
$ vendor/bin/phpunit
```
## Test through PHP 5.4 ~ PHP 7.0
```console
$ docker-compose up
```
## License
MIT license