roelofjan-elsinga / atom-feed-generator
A package to easily generate an Atom feed.
Installs: 2 877
Dependents: 2
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Requires
- nesbot/carbon: ^2.22
Requires (Dev)
- phpunit/phpunit: ^8.3
- spatie/phpunit-watcher: ^1.11
README
This package helps you to very easily generate an Atom Feed for your website.
Installation
You can include this package through Composer using:
composer require roelofjan-elsinga/atom-feed-generator
Usage
use AtomFeedGenerator\AtomFeedGenerator; /**@var \AtomFeedGenerator\FeedConfiguration $configuration*/ $generator = AtomFeedGenerator::withConfiguration($configuration); // or $generator = new AtomFeedGenerator($configuration); /**@var \AtomFeedGenerator\FeedItem $feed_item*/ $generator->add($feed_item); $atom_string = $generator->generate(); print $atom_string;
This will result in:
<?xml version="1.0" encoding="utf-8"?> <feed xmlns="http://www.w3.org/2005/Atom"> <title>Feed title</title> <link href="https://example.com"/> <updated>2019-01-01T12:00:00+00:00</updated> <author> <name>Feed Author</name> </author> <id>https://example.com</id> <link rel="self" href='https://example.com/feed'/> <entry> <title>Article title</title> <link href="https://example.com/articles/test-article"/> <id>https://example.com/articles/test-article</id> <updated>2019-01-02T12:00:00+00:00</updated> <published>2019-01-01T12:00:00+00:00</published> <content>This is the content of the item</content> <summary>This is the summary</summary> <media:content xmlns:media="http://search.yahoo.com/mrss/" url="/images/test-image.jpg" medium="image" type="image/jpeg" width="1920" height="1080" /> </entry> </feed>
Testing
You can run the included tests by running ./vendor/bin/phpunit
in your terminal.