Class craft\feeds\Feeds

Inheritance: craft\feeds\Feeds » yii\base\Component » yii\base\BaseObject
Implements: yii\base\Configurable
Available since version: 3.0
Source Code: https://github.com/craftcms/cms/blob/master/src/feeds/Feeds.php

The Feeds service provides APIs for fetching remote RSS and Atom feeds.

An instance of the Feeds service is globally accessible in Craft via craft\web\Application::feeds.

Public Methods
Method	Description	Defined By
`__call()`	Calls the named method which is not a class method.	yii\base\BaseObject
`__clone()`	This method is called after the object is created by cloning an existing one.	yii\base\Component
`__construct()`	Constructor.	yii\base\BaseObject
`__get()`	Returns the value of an object property.	yii\base\BaseObject
`__isset()`	Checks if a property is set, i.e. defined and not null.	yii\base\BaseObject
`__set()`	Sets value of an object property.	yii\base\BaseObject
`__unset()`	Sets an object property to null.	yii\base\BaseObject
`attachBehavior()`	Attaches a behavior to this component.	yii\base\Component
`attachBehaviors()`	Attaches a list of behaviors to the component.	yii\base\Component
`behaviors()`	Returns a list of behaviors that this component should behave as.	yii\base\Component
`canGetProperty()`	Returns a value indicating whether a property can be read.	yii\base\BaseObject
`canSetProperty()`	Returns a value indicating whether a property can be set.	yii\base\BaseObject
`className()`	Returns the fully qualified name of this class.	yii\base\BaseObject
`detachBehavior()`	Detaches a behavior from the component.	yii\base\Component
`detachBehaviors()`	Detaches all behaviors from the component.	yii\base\Component
`ensureBehaviors()`	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
`getBehavior()`	Returns the named behavior object.	yii\base\Component
`getBehaviors()`	Returns all behaviors attached to this component.	yii\base\Component
`getFeedItems()`	Fetches and parses an RSS or Atom feed, and returns its items.	craft\feeds\Feeds
`hasEventHandlers()`	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
`hasMethod()`	Returns a value indicating whether a method is defined.	yii\base\BaseObject
`hasProperty()`	Returns a value indicating whether a property is defined.	yii\base\BaseObject
`init()`	Initializes the object.	yii\base\BaseObject
`off()`	Detaches an existing event handler from this component.	yii\base\Component
`on()`	Attaches an event handler to an event.	yii\base\Component
`trigger()`	Triggers an event.	yii\base\Component

Method Details

`getFeedItems()` public method #

Fetches and parses an RSS or Atom feed, and returns its items.

Each element in the returned array will have the following keys:

authors – An array of the item’s authors, where each sub-element has the following keys:
- name – The author’s name
- url – The author’s URL
- email – The author’s email
categories – An array of the item’s categories, where each sub-element has the following keys:
- term – The category’s term
- scheme – The category’s scheme
- label – The category’s label
content – The item’s main content.
contributors – An array of the item’s contributors, where each sub-element has the following keys:
- name – The contributor’s name
- url – The contributor’s URL
- email – The contributor’s email
date – A DateTime object representing the item’s date.
dateUpdated – A DateTime object representing the item’s last updated date.
permalink – The item’s URL.
summary – The item’s summary content.
title – The item’s title.

public array, string getFeedItems ( \craft\feeds\string $url, \craft\feeds\int $limit = null, \craft\feeds\int $offset = null, \craft\feeds\string $cacheDuration = null )

`$url`	string	The feed’s URL.
`$limit`	integer, null	The maximum number of items to return. Default is 0 (no limit).
`$offset`	integer, null	The number of items to skip. Defaults to 0.
`$cacheDuration`	mixed, null	How long to cache the results. See \craft\feeds\Config::timeInSeconds() for possible values.
return	array, string	The list of feed items.
throws	\Zend\Feed\Reader\Exception\RuntimeException

Method Details

getFeedItems() public method #

`getFeedItems()` public method #