getFeed

getFeed() Delegate Class Method

Synopsis:

The getFeed() method of a table delegate class or application delegate class returns an associative array of parameters to configure the RSS feed for a particular table . An RSS feed consists of the following components:

1. title - The title of the RSS feed as it should appear in the subscribers' feed list.
2. description - Describes the RSS feed.
3. link - A link to the RSS feed
4. syndicationURL - The URL to this RSS feed's site.

Parameters

1. array $query - The HTTP query. Contains information like the current table, current action, and search parameters. This allows you to customize your RSS feed depending on the user's query parameters.

Return Value

The getFeed() method returns an associative array with the components of the RSS feed. This array does not need to contain all possible keys, or even any keys. Any keys that are omitted will simply use default values in the RSS feed. The array may contain the following keys:

Example

function getFeed(&$query){
    return array(
        'title' => "RSS feed for the ".$query['-table']." table.",
        'description' => "News and updates for automobiles",
        'link' => df_absolute_url(DATAFACE_SITE_HREF),
        'syndicationURL' => df_absolute_url(DATAFACE_SITE_HREF)
    );
}

Note that RSS feeds will work perfectly well without defining this method. This just allows you to customize one or more parameters of the RSS feed.

See Also:

• getFeedItem - A delegate class method available to both the table delegate classes to configure parameters for the particular items of the RSS feed.
• getRelatedFeed? - A delegate class method available to both the application delegate class and the table delegate classes to configure the RSS feed for a related records list.
• getRSSDescription? - A delegate class method to override the description that appears for a particular record in an RSS feed. (The same as the description parameter of the getFeedItem method.
• Introduction to RSS Feeds in Xataface - An overview of Xataface's RSS feed support.