marcw/rss-writer

A simple yet powerful RSS2 feed writer with RSS extensions support (like iTunes podcast tags)

RssWriter

, _(*1)

A simple, yet powerful and fully customizable RSS 2.0 writing library, with a native support of iTunes podcasting tags and other RSS extensions., _(*2)

Why a new Rss writing library?

At the time of writing this library, the current state of feed writing libraries was not satisfying. What I found was either difficult to extend, too generic, or wasn't taking advantage of best practices in order to reduce the Time To First Byte., _(*3)

Why should I use this over other libraries?

Use this library if you want:, _(*4)

• RSS2 feeds (because there's no support for other types of feed).
• Extensions for iTunes podcasting, Slash, Sy, DublinCreator, Atom, or just your own.
• Best performance (memory and TTFB) thanks to XML Streaming.
• Object oriented feed creation with POPO

How can I install it?

Run composer require marcw/rss-writer., _(*5)

How does it work?

Feed creation

See this file., _(*6)

Rss Streamed Response

See this file., _(*7)

Symfony Bridge

HttpFoundation

The library provides an extension to the Symfony\Component\HttpFoundation\Response class for streaming rss responses to the client. See RssStreamedResponse.php. Use it from your controllers like this:, _(*8)

use MarcW\RssWriter\Bridge\Symfony\HttpFoundation\RssStreamedResponse;

public function myAction()
{
    // $channel = ... (whatever you use to create your Channel object)

    return new RssStreamedResponse($channel, $this->get('marcw_rss_writer.rss_writer'));
}

Form

An iTunes category choice list is available to use in your forms. Follow this example:, _(*9)

<?php

namespace AppBundle\Form;

use MarcW\RssWriter\Bridge\Symfony\Form\ChoiceList\Loader\ItunesCategoryChoiceLoader;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\Form\FormBuilderInterface;

class MyFormType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        // ...
        $builder->add('category', ChoiceType::class, ['choice_loader' => new ItunesCategoryChoiceLoader()])
        // ...
    }
}

Symfony Bundle

This library also provides a Symfony bundle., _(*10)

Add this to your AppKernel.php file., _(*11)

new MarcW\RssWriter\Bundle\MarcWRssWriterBundle()

You can now use the marcw_rss_writer.rss_writer service., _(*12)

Can I contribute?

Sure! Feel free to report issues, send pull-requests, or ask for help., _(*13)

Projects using this lib

• Banditore retrieves new releases from your Github starred repositories and put them in a RSS feed.

LICENSE

See the LICENSE file., _(*14)