FeedEntry
Class to encapsulate a feed entry for the Joomla Platform.
| since |
3.1.4 |
|---|---|
| package |
Joomla CMS |
Methods
__get
Magic method to return values for feed entry properties.
__get( name) :
| since |
3.1.4 |
|---|
Arguments
- name
stringThe name of the property.
Response
mixed
__set
Magic method to set values for feed properties.
__set( name, value) :
| since |
3.1.4 |
|---|
Arguments
- name
stringThe name of the property.- value
mixedThe value to set for the property.
Response
void
addCategory
Method to add a category to the feed entry object.
addCategory( name, 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( name, email, uri = null, 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( name) : \Joomla\CMS\Feed\FeedEntry
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( name, email, uri = null, 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
author
categories
Categories to which the feed entry belongs.
Type(s)
array<string|int, mixed>
content
The content of the feed entry.
Type(s)
string
contributors
People who contributed to the feed entry content.
Type(s)
array<string|int, mixed>
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<string|int, mixed>
publishedDate
source
title
A human readable title for the feed entry.
Type(s)
string
updatedDate
uri
Universal, permanent identifier for the feed entry.
Type(s)
string
properties
The entry properties.
| since |
3.1.4 |
|---|
Type(s)
array<string|int, mixed>