An open API service indexing awesome lists of open source software.

https://github.com/rluders/oc-feedreader-plugin

FeedReader component plugin for OctoberCMS.
https://github.com/rluders/oc-feedreader-plugin

feedreader octobercms octobercms-plugin

Last synced: 12 months ago
JSON representation

FeedReader component plugin for OctoberCMS.

Awesome Lists containing this project

README

          

# Description

This plugin provides an extensive and simple component that allows you to get a list from any feed and place it into your website. It's excellent if you need to display your WordPress blog posts on your October CMS website.

# Installation

[Go to the plugin page](https://octobercms.com/plugin/rluders-feedreader)

# FAQ

## Does it support multiple feed components in one page
Yes. It does support. Just remember to rename the component alias.

## Can I merge two feeds?
Yes. You can! Just add all the feed URLs that you wanna merge into the `Feed URL` component property, separated by `;`.

**Example:**
http://site1.com/feed;http://site2.com/feed

# Component Implementation

```php
[feedList]
...
==
{% component "feedList" %}
```

It's better if you just drag the component to your page an them configure it.

# Component Properties

- **Feed URL**, must be a valid URL address to the XML feed that you wanna read.
- **Expire cache** (in minutes), how much time the plugin will keep a cache from the feed.

# Overwrite the component
If you choose to overwrite the default partial, the feed item has this following attributes that can be used inside the for loop:

**Item id**

*string*

``{{ item.id }}``

**Item title**

*string*

``{{ item.title }}``

**Item url**

*string*

``{{ item.url }}``

**Item author**

*string*

``{{ item.author }}``

**Item date**

*DateTime*

``{{ item.date }}``

**Item published date**

*DateTime*

``{{ item.publishedDate }}``

**Item updated date**

*DateTime*

``{{ item.updatedDate }}``

**Item content**

*string*

``{{ item.content }}``

**Item enclosure url**

*string*

``{{ item.enclosureUrl }}``

**Item enclusure type**

*string*

``{{ item.enclosureType }}``

**Item language**

*string*

``{{ item.language }}``

**Item categories**

*array*

``{{ item.categories }}``

# License

GPLv3