Back to Joomla project (class list)

Class FeedEntry - list of methods

Class to encapsulate a feed entry for the Joomla Platform.
Package: Joomla\CMS\Feed
Copyright: (C) 2012 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Feed/FeedEntry.php
Project: Joomla

Method Summary

public mixed
(mixed $name)

Magic method to return values for feed entry properties.
Parameters
  • string $name The name of the property.
Returns
  • mixed
Since
  • 3.1.4
Show source code of this method: __get Source Code

public void
(mixed $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.
Returns
  • void
Since
  • 3.1.4
Show source code of this method: __set Source Code

public \Joomla\CMS\Feed\FeedEntry
(mixed $name, mixed $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.
Returns
  • \Joomla\CMS\Feed\FeedEntry
Since
  • 3.1.4
Show source code of this method: addCategory Source Code

public \Joomla\CMS\Feed\FeedEntry
(mixed $name, mixed $email, mixed $uri = null, mixed $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.
Returns
  • \Joomla\CMS\Feed\FeedEntry
Since
  • 3.1.4
Show source code of this method: addContributor Source Code

public \Joomla\CMS\Feed\FeedEntry
(\Joomla\CMS\Feed\FeedLink $link)

Method to add a link to the feed entry object.
Parameters
  • \Joomla\CMS\Feed\FeedLink $link The link object to add.
Returns
  • \Joomla\CMS\Feed\FeedEntry
Since
  • 3.1.4
Show source code of this method: addLink Source Code

public \Joomla\CMS\Feed\FeedEntry
(mixed $name)

Method to remove a category from the feed entry object.
Parameters
  • string $name The name of the category to remove.
Returns
  • \Joomla\CMS\Feed\FeedEntry
Since
  • 3.1.4
Show source code of this method: removeCategory Source Code

public \Joomla\CMS\Feed\FeedEntry
(\Joomla\CMS\Feed\FeedPerson $contributor)

Method to remove a contributor from the feed entry object.
Parameters
  • \Joomla\CMS\Feed\FeedPerson $contributor The person object to remove.
Returns
  • \Joomla\CMS\Feed\FeedEntry
Since
  • 3.1.4
Show source code of this method: removeContributor Source Code

public \Joomla\CMS\Feed\FeedEntry
(\Joomla\CMS\Feed\FeedLink $link)

Method to remove a link from the feed entry object.
Parameters
  • \Joomla\CMS\Feed\FeedLink $link The link object to remove.
Returns
  • \Joomla\CMS\Feed\FeedEntry
Since
  • 3.1.4
Show source code of this method: removeLink Source Code

public \Joomla\CMS\Feed\FeedEntry
(mixed $name, mixed $email, mixed $uri = null, mixed $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.
Returns
  • \Joomla\CMS\Feed\FeedEntry
Since
  • 3.1.4
Show source code of this method: setAuthor Source Code

Properties Summary

protected array
$properties
Since
  • 3.1.4

Tags Summary

public\Joomla\CMS\Feed\FeedPerson
$author
Person responsible for feed entry content.
publicarray
$categories
Categories to which the feed entry belongs.
publicstring
$content
The content of the feed entry.
publicarray
$contributors
People who contributed to the feed entry content.
publicstring
$copyright
Information about rights, e.g. copyrights, held in and over the feed entry.
publicarray
$links
Links associated with the feed entry.
public\Joomla\CMS\Date\Date
$publishedDate
The publication date for the feed entry.
public\Joomla\CMS\Feed\Feed
$source
The feed from which the entry is sourced.
publicstring
$title
A human readable title for the feed entry.
public\Joomla\CMS\Date\Date
$updatedDate
The last time the content of the feed entry changed.
publicstring
$uri
Universal, permanent identifier for the feed entry.
Since
3.1.4