Class JFeed

Class to encapsulate a feed for the Joomla Platform.

JFeed implements ArrayAccess, Countable

Package: Joomla\Platform\Feed
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 12.3
Located at joomla/feed/feed.php

Methods summary

`public mixed`	# `__get( string $name )` Magic method to return values for feed properties. Magic method to return values for feed properties. Parameters `$name` `string` - $name The name of the property. Returns `mixed` Since 12.3
`public`	# `__set( string $name, mixed $value )` Magic method to set values for feed properties. Magic method to set values for feed properties. Parameters `$name` `string` - $name The name of the property. `$value` `mixed` - $value The value to set for the property. Since 12.3
`public JFeed`	# `addCategory( string $name, string $uri = '' )` Method to add a category to the feed object. Method to add a category to the feed object. Parameters `$name` `string` - $name The name of the category to add. `$uri` `string` - $uri The optional URI for the category to add. Returns `JFeed` Since 12.3
`public JFeed`	# `addContributor( string $name, string $email, string $uri = null, string $type = null )` Method to add a contributor to the feed object. Method to add a contributor to the feed object. Parameters `$name` `string` - $name The full name of the person to add. `$email` `string` - $email The email address of the person to add. `$uri` `string` - $uri The optional URI for the person to add. `$type` `string` - $type The optional type of person to add. Returns `JFeed` Since 12.3
`public JFeed`	# `addEntry( JFeedEntry $entry )` Method to add an entry to the feed object. Method to add an entry to the feed object. Parameters `$entry` `JFeedEntry` - $entry The entry object to add. Returns `JFeed` Since 12.3
`public integer`	# `count( )` Returns a count of the number of entries in the feed. Returns a count of the number of entries in the feed. This method is here to implement the Countable interface. You can call it by doing count($feed) rather than $feed->count(); Returns `integer` - number of entries in the feed. Implementation of `Countable::count()`
`public boolean`	# `offsetExists( mixed $offset )` Whether or not an offset exists. This method is executed when using isset() or empty() on objects implementing ArrayAccess. Whether or not an offset exists. This method is executed when using isset() or empty() on objects implementing ArrayAccess. Parameters `$offset` `mixed` - $offset An offset to check for. Returns `boolean` Since 12.3 See `ArrayAccess::offsetExists()` Implementation of `ArrayAccess::offsetExists()`
`public mixed`	# `offsetGet( mixed $offset )` Returns the value at specified offset. Returns the value at specified offset. Parameters `$offset` `mixed` - $offset The offset to retrieve. Returns `mixed` - The value at the offset. Since 12.3 See `ArrayAccess::offsetGet()` Implementation of `ArrayAccess::offsetGet()`
`public boolean`	# `offsetSet( mixed $offset, JFeedEntry $value )` Assigns a value to the specified offset. Assigns a value to the specified offset. Parameters `$offset` `mixed` - $offset The offset to assign the value to. `$value` `JFeedEntry` - $value The JFeedEntry to set. Returns `boolean` Throws `InvalidArgumentException` Since 12.3 See `ArrayAccess::offsetSet()` Implementation of `ArrayAccess::offsetSet()`
`public`	# `offsetUnset( mixed $offset )` Unsets an offset. Unsets an offset. Parameters `$offset` `mixed` - $offset The offset to unset. Since 12.3 See `ArrayAccess::offsetUnset()` Implementation of `ArrayAccess::offsetUnset()`
`public JFeed`	# `removeCategory( string $name )` Method to remove a category from the feed object. Method to remove a category from the feed object. Parameters `$name` `string` - $name The name of the category to remove. Returns `JFeed` Since 12.3
`public JFeed`	# `removeContributor( JFeedPerson $contributor )` Method to remove a contributor from the feed object. Method to remove a contributor from the feed object. Parameters `$contributor` `JFeedPerson` - $contributor The person object to remove. Returns `JFeed` Since 12.3
`public JFeed`	# `removeEntry( JFeedEntry $entry )` Method to remove an entry from the feed object. Method to remove an entry from the feed object. Parameters `$entry` `JFeedEntry` - $entry The entry object to remove. Returns `JFeed` Since 12.3
`public JFeed`	# `setAuthor( string $name, string $email, string $uri = null, string $type = null )` Shortcut method to set the author for the feed object. Shortcut method to set the author for the feed object. Parameters `$name` `string` - $name The full name of the person to set. `$email` `string` - $email The email address of the person to set. `$uri` `string` - $uri The optional URI for the person to set. `$type` `string` - $type The optional type of person to set. Returns `JFeed` Since 12.3
`public JFeed`	# `reverseItems( )` Method to reverse the items if display is set to 'oldest first' Method to reverse the items if display is set to 'oldest first' Returns `JFeed` Since 12.3

Magic methods summary

Properties summary

`protected array`	`$properties`	# The entry properties. The entry properties. Since 12.3
`protected array`	`$entries`	# The list of feed entry objects. The list of feed entry objects. Since 12.3

Magic properties

`public JFeedPerson`	`$author`	# Person responsible for feed content. Person responsible for feed content.
`public array`	`$categories`	# Categories to which the feed belongs. Categories to which the feed belongs.
`public array`	`$contributors`	# People who contributed to the feed content. People who contributed to the feed content.
`public string`	`$copyright`	# Information about rights, e.g. copyrights, held in and over the feed. Information about rights, e.g. copyrights, held in and over the feed.
`public string`	`$description`	# A phrase or sentence describing the feed. A phrase or sentence describing the feed.
`public string`	`$generator`	# A string indicating the program used to generate the feed. A string indicating the program used to generate the feed.
`public string`	`$image`	# Specifies a GIF, JPEG or PNG image that should be displayed with the feed. Specifies a GIF, JPEG or PNG image that should be displayed with the feed.
`public JDate`	`$publishedDate`	# The publication date for the feed content. The publication date for the feed content.
`public string`	`$title`	# A human readable title for the feed. A human readable title for the feed.
`public JDate`	`$updatedDate`	# The last time the content of the feed changed. The last time the content of the feed changed.
`public string`	`$uri`	# Universal, permanent identifier for the feed. Universal, permanent identifier for the feed.

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JFeed

Methods summary

Parameters

Returns

Since

Parameters

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Implementation of

Parameters

Returns

Since

See

Implementation of

Parameters

Returns

Since

See

Implementation of

Parameters

Returns

Throws

Since

See

Implementation of

Parameters

Since

See

Implementation of

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Magic methods summary

Properties summary

Since

Since

Magic properties