FeedEntry
Class to encapsulate a feed entry for the Joomla Platform.
| since |
3.1.4 |
|---|
Methods
__get
Magic method to return values for feed entry properties.
__get(string $name) : mixed
| since |
3.1.4 |
|---|
Arguments
- $name
stringThe name of the property.
Response
mixed
__set
Magic method to set values for feed properties.
__set(string $name, mixed $value) : void
| since |
3.1.4 |
|---|
Arguments
- $name
stringThe name of the property.- $value
mixedThe value to set for the property.
addCategory
Method to add a category to the feed entry object.
addCategory(string $name, string $uri = '') : \Joomla\CMS\Feed\FeedEntry
| since |
3.1.4 |
|---|
Arguments
- $name
stringThe name of the category to add.- $uri
stringThe optional URI for the category to add.
Response
addContributor
Method to add a contributor to the feed entry object.
addContributor(string $name, string $email, string $uri = null, string $type = null) : \Joomla\CMS\Feed\FeedEntry
| since |
3.1.4 |
|---|
Arguments
- $name
stringThe full name of the person to add.stringThe email address of the person to add.- $uri
stringThe optional URI for the person to add.- $type
stringThe optional type of person to add.
Response
addLink
Method to add a link to the feed entry object.
addLink(\Joomla\CMS\Feed\FeedLink $link) : \Joomla\CMS\Feed\FeedEntry
removeCategory
Method to remove a category from the feed entry object.
removeCategory(string $name) : \Joomla\CMS\Feed\FeedEntry
| since |
3.1.4 |
|---|
Arguments
- $name
stringThe name of the category to remove.
Response
removeContributor
Method to remove a contributor from the feed entry object.
removeContributor(\Joomla\CMS\Feed\FeedPerson $contributor) : \Joomla\CMS\Feed\FeedEntry
removeLink
Method to remove a link from the feed entry object.
removeLink(\Joomla\CMS\Feed\FeedLink $link) : \Joomla\CMS\Feed\FeedEntry
setAuthor
Shortcut method to set the author for the feed entry object.
setAuthor(string $name, string $email, string $uri = null, string $type = null) : \Joomla\CMS\Feed\FeedEntry
| since |
3.1.4 |
|---|
Arguments
- $name
stringThe full name of the person to set.stringThe email address of the person to set.- $uri
stringThe optional URI for the person to set.- $type
stringThe optional type of person to set.
Response
Properties
properties
The entry properties.
| since |
3.1.4 |
|---|
Type(s)
array
author
Person responsible for feed entry content.
Type(s)
\Joomla\CMS\Feed\FeedPerson
categories
Categories to which the feed entry belongs.
Type(s)
array
content
The content of the feed entry.
Type(s)
string
contributors
People who contributed to the feed entry content.
Type(s)
array
copyright
Information about rights, e.g. copyrights, held in and over the feed entry.
Type(s)
string
links
Links associated with the feed entry.
Type(s)
array
publishedDate
The publication date for the feed entry.
Type(s)
\Joomla\CMS\Date\Date
source
The feed from which the entry is sourced.
Type(s)
\Joomla\CMS\Feed\Feed
title
A human readable title for the feed entry.
Type(s)
string
updatedDate
The last time the content of the feed entry changed.
Type(s)
\Joomla\CMS\Date\Date
uri
Universal, permanent identifier for the feed entry.
Type(s)
string