1. class
  2. Joomla
  3. CMS
  4. Feed
  5. FeedEntry

FeedEntry

class FeedEntry

Class to encapsulate a feed entry for the Joomla Platform.

Properties

FeedPerson $author FeedPerson$authorPerson responsible for feed entry content.
array $categories array$categoriesCategories to which the feed entry belongs.
string $content string$contentThe content of the feed entry.
array $contributors array$contributorsPeople who contributed to the feed entry content.
$copyright string$copyrightInformation about rights, e.g. copyrights, held in and over the feed entry.
array$linksLinks associated with the feed entry.
Date $publishedDate Date$publishedDateThe publication date for the feed entry.
Feed $source Feed$sourceThe feed from which the entry is sourced.
string $title string$titleA human readable title for the feed entry.
Date $updatedDate Date$updatedDateThe last time the content of the feed entry changed.
string $uri string$uriUniversal, permanent identifier for the feed entry.

Methods

mixed
__get( string $name)

Magic method to return values for feed entry properties.

void
__set( string $name, mixed $value)

Magic method to set values for feed properties.

FeedEntry
addCategory( string $name, string $uri = '')

Method to add a category to the feed entry object.

FeedEntry
addContributor( string $name, string $email, string $uri = null, string $type = null)

Method to add a contributor to the feed entry object.

FeedEntry
addLink( FeedLink $link)

Method to add a link to the feed entry object.

FeedEntry
removeCategory( string $name)

Method to remove a category from the feed entry object.

FeedEntry
removeContributor( FeedPerson $contributor)

Method to remove a contributor from the feed entry object.

FeedEntry
removeLink( FeedLink $link)

Method to remove a link from the feed entry object.

FeedEntry
setAuthor( string $name, string $email, string $uri = null, string $type = null)

Shortcut method to set the author for the feed entry object.

Details

mixed __get( string $name)

Magic method to return values for feed entry properties.

Parameters

string $name The name of the property.

Return Value

mixed

void __set( string $name, mixed $value)

Magic method to set values for feed properties.

Parameters

string $name The name of the property.
mixed $value The value to set for the property.

Return Value

void

FeedEntry addCategory( string $name, string $uri = '')

Method to add a category to the feed entry object.

Parameters

string $name The name of the category to add.
string $uri The optional URI for the category to add.

Return Value

FeedEntry

FeedEntry addContributor( string $name, string $email, string $uri = null, string $type = null)

Method to add a contributor to the feed entry object.

Parameters

string $name The full name of the person to add.
string $email The email address of the person to add.
string $uri The optional URI for the person to add.
string $type The optional type of person to add.

Return Value

FeedEntry

Method to add a link to the feed entry object.

Parameters

FeedLink $link The link object to add.

Return Value

FeedEntry

FeedEntry removeCategory( string $name)

Method to remove a category from the feed entry object.

Parameters

string $name The name of the category to remove.

Return Value

FeedEntry

FeedEntry removeContributor( FeedPerson $contributor)

Method to remove a contributor from the feed entry object.

Parameters

FeedPerson $contributor The person object to remove.

Return Value

FeedEntry

Method to remove a link from the feed entry object.

Parameters

FeedLink $link The link object to remove.

Return Value

FeedEntry

FeedEntry setAuthor( string $name, string $email, string $uri = null, string $type = null)

Shortcut method to set the author for the feed entry object.

Parameters

string $name The full name of the person to set.
string $email The email address of the person to set.
string $uri The optional URI for the person to set.
string $type The optional type of person to set.

Return Value

FeedEntry