Docs For Class JFeedEntry

Description

Class to encapsulate a feed entry for the Joomla Platform.

property: JFeedPerson $author: Person responsible for feed entry content.
property: array $categories: Categories to which the feed entry belongs.
property: string $content: The content of the feed entry.
property: array $contributors: People who contributed to the feed entry content.
property: string $copyright: Information about rights, e.g. copyrights, held in and over the feed entry.
property: array $links: Links associated with the feed entry.
property: JDate $publishedDate: The publication date for the feed entry.
property: JFeed $source: The feed from which the entry is sourced.
property: string $title: A human readable title for the feed entry.
property: JDate $updatedDate: The last time the content of the feed entry changed.
property: string $uri: Universal, permanent identifier for the feed entry.
since: 12.3

Located in /libraries/joomla/feed/entry.php (line 31)

Variable Summary

array $properties

Method Summary

JFeedEntry addCategory (string $name, [string $uri = ''])

JFeedEntry addContributor (string $name, string $email, [string $uri = null], [string $type = null])

JFeedEntry addLink (JFeedLink $link)

JFeedEntry removeCategory (string $name)

JFeedEntry removeContributor (JFeedPerson $contributor)

JFeedEntry removeLink (JFeedLink $link)

JFeedEntry setAuthor (string $name, string $email, [string $uri = null], [string $type = null])

mixed __get (string $name)

void __set (string $name, mixed $value)

Variables

array $properties = array(
'uri' => '',
'title' => '',
'updatedDate' => '',
'content' => '',
'categories' => array(),'contributors'=>array(),'links'=>array()) (line 37)

var: The entry properties.
since: 12.3
access: protected

Methods

addCategory (line 110)

Method to add a category to the feed entry object.

since: 12.3
access: public

JFeedEntry addCategory (string $name, [string $uri = ''])

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

addContributor (line 129)

Method to add a contributor to the feed entry object.

since: 12.3
access: public

JFeedEntry addContributor (string $name, string $email, [string $uri = null], [string $type = null])

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.

addLink (line 157)

Method to add a link to the feed entry object.

since: 12.3
access: public

JFeedEntry addLink (JFeedLink $link)

JFeedLink $link: The link object to add.

removeCategory (line 183)

Method to remove a category from the feed entry object.

since: 12.3
access: public

JFeedEntry removeCategory (string $name)

string $name: The name of the category to remove.

removeContributor (line 199)

Method to remove a contributor from the feed entry object.

since: 12.3
access: public

JFeedEntry removeContributor (JFeedPerson $contributor)

JFeedPerson $contributor: The person object to remove.

removeLink (line 225)

Method to remove a link from the feed entry object.

since: 12.3
access: public

JFeedEntry removeLink (JFeedLink $link)

JFeedLink $link: The link object to remove.

setAuthor (line 254)

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

since: 12.3
access: public

JFeedEntry setAuthor (string $name, string $email, [string $uri = null], [string $type = null])

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.

__get (line 56)

Magic method to return values for feed entry properties.

since: 12.3
access: public

mixed __get (string $name)

string $name: The name of the property.

__set (line 71)

Magic method to set values for feed properties.

since: 12.3
access: public

void __set (string $name, mixed $value)

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