FeedsService

Type
Class
Namespace
Craft
Inherits
Craft\FeedsService » Craft\BaseApplicationComponent » CApplicationComponent » CComponent
Implements
IApplicationComponent
Since
1.0

FeedsService provides APIs for fetching remote RSS and Atom feeds.

An instance of FeedsService is globally accessible in Craft via {@link WebApp::feeds craft()->feeds}.

See also http://craftcms.com

View source

Public Properties

PropertyDescription
$behaviorsarray – The behaviors that should be attached to this component.

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__unset()Sets a component property to be null.
asa()Returns the named behavior object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()Evaluates a PHP expression or callback under the context of this component.
getEventHandlers()Returns the list of attached event handlers for an event.
getFeedItems()Fetches and parses an RSS or Atom feed, and returns its items.
getIsInitialized()Checks if this application component has been initialized.
hasEvent()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
init()Initializes the application component.
isInitialized()Checks if this application component has been initialized yet, or not.
raiseEvent()Raises an event.

getFeedItems()

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 {@link DateTime} object representing the item’s date.
  • dateUpdated – A {@link 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.

View source

Arguments

  • $url (string) – The feed’s URL.
  • $limit (integer) – The maximum number of items to return. Default is 0 (no limit).
  • $offset (integer) – The number of items to skip. Defaults to 0.
  • $cacheDuration (string) – Any valid PHP time format.

Returns

array, string – The list of feed items.

Signature

public array, string getFeedItems ( $url, $limit = 0, $offset = 0, $cacheDuration = null )

init()

Initializes the application component.

View source

Returns

null

Signature

public null init ( )