Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class Feed - list of methods

Class to encapsulate a feed 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/Feed.php
Project: Joomla

Method Summary

public mixed
__get
(mixed $name)

Magic method to return values for feed 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
__set
(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\Feed
(mixed $name, mixed $uri = '')

Method to add a category to the feed 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\Feed
Since
  • 3.1.4
Show source code of this method: addCategory Source Code

public \Joomla\CMS\Feed\Feed
(mixed $name, mixed $email, mixed $uri = null, mixed $type = null)

Method to add a contributor to the feed 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\Feed
Since
  • 3.1.4
Show source code of this method: addContributor Source Code

public \Joomla\CMS\Feed\Feed
(\Joomla\CMS\Feed\FeedEntry $entry)

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

public int
()

Returns a count of the number of entries in the feed.
Returns
  • int number of entries in the feed.
Show source code of this method: count Source Code

public bool
(mixed $offset)

Whether or not an offset exists. This method is executed when using isset() or empty() on objects implementing ArrayAccess.
Parameters
  • mixed $offset An offset to check for.
Returns
  • bool
Since
  • 3.1.4
-
  • \Joomla\CMS\Feed\ArrayAccess::offsetExists()
Show source code of this method: offsetExists Source Code

public mixed
(mixed $offset)

Returns the value at specified offset.
Parameters
  • mixed $offset The offset to retrieve.
Returns
  • mixed The value at the offset.
Since
  • 3.1.4
-
  • \Joomla\CMS\Feed\ArrayAccess::offsetGet()
Show source code of this method: offsetGet Source Code

public bool
(mixed $offset, mixed $value)

Assigns a value to the specified offset.
Parameters
  • mixed $offset The offset to assign the value to.
  • \Joomla\CMS\Feed\FeedEntry $value The JFeedEntry to set.
Returns
  • bool
Since
  • 3.1.4
-
  • \Joomla\CMS\Feed\ArrayAccess::offsetSet()
  • \InvalidArgumentException
Show source code of this method: offsetSet Source Code

public void
(mixed $offset)

Unsets an offset.
Parameters
  • mixed $offset The offset to unset.
Returns
  • void
Since
  • 3.1.4
-
  • \Joomla\CMS\Feed\ArrayAccess::offsetUnset()
Show source code of this method: offsetUnset Source Code

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

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

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

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

public \Joomla\CMS\Feed\Feed
(\Joomla\CMS\Feed\FeedEntry $entry)

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

public \Joomla\CMS\Feed\Feed
(mixed $name, mixed $email, mixed $uri = null, mixed $type = null)

Shortcut method to set the author for the feed 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\Feed
Since
  • 3.1.4
Show source code of this method: setAuthor Source Code

public \Joomla\CMS\Feed\Feed
()

Method to reverse the items if display is set to 'oldest first'
Returns
  • \Joomla\CMS\Feed\Feed
Since
  • 3.1.4
Show source code of this method: reverseItems Source Code

Properties Summary

protected array
$properties
Since
  • 3.1.4
protected array
$entries
Since
  • 3.1.4

Tags Summary

public\Joomla\CMS\Feed\FeedPerson
$author
Person responsible for feed content.
publicarray
$categories
Categories to which the feed belongs.
publicarray
$contributors
People who contributed to the feed content.
publicstring
$copyright
Information about rights, e.g. copyrights, held in and over the feed.
publicstring
$description
A phrase or sentence describing the feed.
publicstring
$generator
A string indicating the program used to generate the feed.
public\Joomla\CMS\Feed\FeedLink|null
$image
FeedLink object containing feed image properties.
public\Joomla\CMS\Date\Date
$publishedDate
The publication date for the feed content.
publicstring
$title
A human readable title for the feed.
public\Joomla\CMS\Date\Date
$updatedDate
The last time the content of the feed changed.
publicstring
$uri
Universal, permanent identifier for the feed.
Since
3.1.4