README

Very light weight PHP API encapsulating entire RSS-2 specification, the worldwide standard at this moment for generating RSS feeds.

API only requires PHP 8.1+ and comes with a class for each RSS tag, all belonging to Lucinda\RSS namespace, each implementing Tag interface. Following are factually mandatory:

Simple example:

$channel = new \Lucinda\RSS\Channel("Lucinda Framework", "https://www.lucinda-framework.com", "Current headlines from Lucinda Framework");
$channel->addItem(new \Lucinda\RSS\Item("STDOUT MVC API", "STDOUT MVC API was upgraded to a new version"));
$channel->addItem(new \Lucinda\RSS\Item("STDERR MVC API", "STDERR MVC API was upgraded to a new version"));
$rss = new \Lucinda\RSS\RSS($channel);
echo $rss; // displays RSS feed

API enjoys 100% unit test coverage for its classes and methods, reproductible in console by running:

composer update
php test.php

NOTICE: since superglobal __toString is not unit testable, unit tests were done on toString method instead!

RSS

Class RSS encapsulates rss tag logic via following void returning methods:

To understand more how namespaces can be used to add non-standard tags to feed, visit this guide!

Channel

Class Channel encapsulates channel tag logic via following void returning methods:

[1] Value of $description is automatically escaped using CDATA via Escape class, in order to make it possible to put HTML inside

Item

Class Item encapsulates item tag logic via following void returning methods:

[1] Value of $description is automatically escaped using CDATA via Escape class, in order to make it possible to put HTML inside

Tag

Interface Tag defines common ability of all RSS tags to be \Stringable

Escape

Class Escape envelopes a value using CDATA via following method inherited from Tag: