class Rss

Model for generating RSS feeds from content objects.

Methods

__construct(Database $database, CriteriaFactory $criteriaFactory, Preference $preference, Cache $cache)

Constructor.

string
copyright()

Return site (feed) copyright.

array
customFeed(int $id)

Customise RSS feed title and description for a specific tag or collection.

description()

Return site (feed) description.

array
getObjects(int $parentId = 0)

Return content objects for the feed.

array
getObjectsforTag(int $tagId)

Return content objects for a given tag.

string
managingEditor()

Return managing editor email address.

string
siteEmail()

Return site administrative email address.

string
title()

Return site (feed) title.

string
webMaster()

Return site webmaster's email address.

Details

at line 49
__construct(Database $database, CriteriaFactory $criteriaFactory, Preference $preference, Cache $cache)

Constructor.

Parameters

Database $database Instance of the Tuskfish database class.
CriteriaFactory $criteriaFactory Instance of the criteria factory class.
Preference $preference Instance of the Tuskfish site preferences class.
Cache $cache Instance of the Tuskfish cache class.

Return site (feed) copyright.

Return Value

string

at line 80
array customFeed(int $id)

Customise RSS feed title and description for a specific tag or collection.

Parameters

int $id ID of a target tag or collection object.

Return Value

array Array containing title and description of custom feed.

at line 100
description()

Return site (feed) description.

at line 111
array getObjects(int $parentId = 0)

Return content objects for the feed.

Parameters

int $parentId ID of the parent collection, if any.

Return Value

array Array of content objects.

at line 138
array getObjectsforTag(int $tagId)

Return content objects for a given tag.

Parameters

int $tagId ID of the tag.

Return Value

array Array of content objects.

at line 189
string managingEditor()

Return managing editor email address.

Return Value

string Email address.

at line 199
string siteEmail()

Return site administrative email address.

Return Value

string Email address.

at line 209
string title()

Return site (feed) title.

Return Value

string Title, as set in site preferences.

at line 219
string webMaster()

Return site webmaster's email address.

Return Value

string Email address.