FeedsService
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\FeedsService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
- 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 (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $behaviors (opens new window) | array (opens new window) – The behaviors that should be attached to this component. |
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __get() (opens new window) | Returns a property value, an event handler list or a behavior based on its name. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| asa() (opens new window) | Returns the named behavior object. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| attachEventHandler() (opens new window) | Attaches an event handler to an event. |
| canGetProperty() (opens new window) | Determines whether a property can be read. |
| canSetProperty() (opens new window) | Determines whether a property can be set. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| detachEventHandler() (opens new window) | Detaches an existing event handler. |
| disableBehavior() (opens new window) | Disables an attached behavior. |
| disableBehaviors() (opens new window) | Disables all behaviors attached to this component. |
| enableBehavior() (opens new window) | Enables an attached behavior. |
| enableBehaviors() (opens new window) | Enables all behaviors attached to this component. |
| evaluateExpression() (opens new window) | Evaluates a PHP expression or callback under the context of this component. |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getFeedItems() | Fetches and parses an RSS or Atom feed, and returns its items. |
| getIsInitialized() (opens new window) | Checks if this application component has been initialized. |
| hasEvent() (opens new window) | Determines whether an event is defined. |
| hasEventHandler() (opens new window) | Checks whether the named event has attached handlers. |
| hasProperty() (opens new window) | Determines whether a property is defined. |
| init() | Initializes the application component. |
| isInitialized() | Checks if this application component has been initialized yet, or not. |
| raiseEvent() (opens new window) | 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 (opens new window)
Arguments
$url(string (opens new window)) – The feed’s URL.$limit(integer (opens new window)) – The maximum number of items to return. Default is 0 (no limit).$offset(integer (opens new window)) – The number of items to skip. Defaults to 0.$cacheDuration(string (opens new window)) – Any valid PHP time format (opens new window).
Returns
array (opens new window), string (opens new window) – The list of feed items.
Signature
public array, string getFeedItems ( $url, $limit = 0, $offset = 0, $cacheDuration = null )
# init()
Signature
public null init ( )