Download the PHP package dodecastudio/craft-feedreader without Composer

On this page you can find all versions of the php package dodecastudio/craft-feedreader. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package craft-feedreader

FeedReader plugin for Craft CMS

Requirements

Installation

Install the plugin as follows:

  1. Open your terminal and go to your Craft project:

    cd /path/to/project

  2. Then tell Composer to load the plugin:

    composer require dodecastudio/craft-feedreader
  3. In the Control Panel, go to Settings → Plugins and click the “Install” button for FeedReader.

Overview

The FeedReader plugin makes use of Craft's built-in Feeds API to load and display RSS or Atom feeds directly in templates. As the Feeds API was deprecated in Craft 4, this plugin borrows the original code from Craft 3 in order to ensure function across both these versions of Craft.

Using FeedReader

Fetching a feed

The getFeed variable will fetch a feed and return feed information and feed items as an array.

You can then output information about the feed and the items it contains, like so:

Supported parameters

The parameters available for the getFeed variable are:

Parameter Type Default Description
url String The URL of the feed being loaded.
cacheDuraction Int 86400 The duration in seconds for which to cache the feed result. The default of 86400 can be overridden using a custom settings config file.
normalize Boolean true Whether or not to "normalize" the data returned for each item or entry. This is helpful when non-standard data is being returned.

Fetching feed items

If you don't need feed information and would like a little bit more control over the feed items, then the getFeedItems variable will fetch feed items and return them as an array.

You can then output the items, like so:

Supported parameters

The parameters available for the getFeedItems variable are:

Parameter Type Default Description
url String The URL of the feed being loaded.
limit Int 20 The number of feed items to return.
offset Int 0 The starting index of the item from which to start the returned feed items.
cacheDuraction Int 86400 The duration in seconds for which to cache the feed result. The default of 86400 can be overridden using a custom settings config file.
normalize Boolean true Whether or not to "normalize" the data returned for each item or entry. This is helpful when non-standard data is being returned.

Plugin Settings

Default settings can be overridden. Please see the feedreader-config.php file for details.

All versions of craft-feedreader with dependencies

PHP Build Version
Package Version
Requires php Version >=7.4
craftcms/cms Version ^3.0|^4.0|^5.0
laminas/laminas-feed Version >=2.17.0
guzzlehttp/guzzle Version ^7.2.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package dodecastudio/craft-feedreader contains the following files

Loading the files please wait ...