inspirecharles/rsswriter

Yii2 module for automatically generation RSS 2.0 feeds

Maintainers

Details

github.com/inspirecharles/rsswriter

Source

Issues

Installs: 69

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 0

Open Issues: 0

Type:yii2-extension

1.0.1 2018-02-08 09:40 UTC

MIT 6d0aa1eb7f5932ca49a1229b7d8e507d9a06c84b

modulersswriteryii2

This package is not auto-updated.

Last update: 2025-06-16 22:05:39 UTC

README

Yii2 module for automatically generation RSS 2.0 feeds.

Main features:

  • automatic caching of rss feeds
  • unlimited number of rss feeds
  • flexible module configuration

Installation

The preferred way to install this extension is through composer.

  • Either run
php composer.phar require --prefer-dist "inspirecharles/rsswriter" "*"

or add

"inspirecharles/rsswriter" : "*"

to the require section of your application's composer.json file.

  • Apply all available migrations in migrations folder:
$ php yii migrate/up --migrationPath=@vendor/inspirecharles/rsswriter/migrations
  • Configure the cache component of your application's configuration file, for example:
'components' => [
    'cache' => [
        'class' => 'yii\caching\FileCache',
    ],
]
  • Add a new module in modules section of your application's configuration file, for example:
'modules' => [
    'rss' => [
        'class' => 'inspirecharles\rss\Rss',
        'feeds' => [
            'rss' => [
                'title' => 'Feed title',
                'description' => 'feed description',
                'link' => 'http://your.site.com/',
                'language' => 'en-US'
            ],
        ]
    ],
],
  • Add a new rule for urlManager of your application's configuration file, for example:
'urlManager' => [
    'rules' => [
        ['pattern' => '<id:rss>', 'route' => 'rss/default/index', 'suffix' => '.xml'],
    ],
],
  • Add a new <link> tag to your <head> tag, for example:
<link rel="alternate" type="application/rss+xml" title="RSS feed" href="/rss.xml" />

Usage

For example:

...
public function beforeSave($insert)
{
    if (parent::beforeSave($insert)) {
        if ($insert) {
            $rss = Yii::$app->getModule('rss');
            $rssItem = $rss->createNewItem();

            $rssItem->title = $this->title;
            $rssItem->description = $this->description;
            $rssItem->link = Url::to($this->url, true);
            $rssItem->pubDate = time();

            return $rss->addItemToFeed('rss', $rssItem);
        }
        return true;
    }
    return false;
}

public function afterDelete()
{
    parent::afterDelete();
    $rss = Yii::$app->getModule('rss');
    
    $rss->deleteItems('rss', ['link' => Url::to($this->url, true)]);
}