Docs For Class JFeed

Description

Implements interfaces:

ArrayAccess (internal interface)

Class to encapsulate a feed for the Joomla Platform.

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

Located in /libraries/joomla/feed/feed.php (line 31)

Variable Summary

array $entries

array $properties

Method Summary

JFeed addCategory (string $name, [string $uri = ''])

JFeed addContributor (string $name, string $email, [string $uri = null], [string $type = null])

JFeed addEntry (JFeedEntry $entry)

boolean offsetExists (mixed $offset)

mixed offsetGet (mixed $offset)

boolean offsetSet (mixed $offset, JFeedEntry $value)

void offsetUnset (mixed $offset)

JFeed removeCategory (string $name)

JFeed removeContributor (JFeedPerson $contributor)

JFeed removeEntry (JFeedEntry $entry)

JFeed setAuthor (string $name, string $email, [string $uri = null], [string $type = null])

mixed __get (string $name)

void __set (string $name, mixed $value)

Variables

array $entries = array() (line 50)

var: The list of feed entry objects.
since: 12.3
access: protected

array $properties = array(
'uri' => '',
'title' => '',
'updatedDate' => '',
'description' => '',
'categories' => array(),'contributors'=>array()) (line 37)

var: The entry properties.
since: 12.3
access: protected

Methods

addCategory (line 109)

Method to add a category to the feed object.

since: 12.3
access: public

JFeed addCategory (string $name, [string $uri = ''])

string $name: The name of the category to add.
string $uri: The optional URI for the category to add.

addContributor (line 128)

Method to add a contributor to the feed object.

since: 12.3
access: public

JFeed addContributor (string $name, string $email, [string $uri = null], [string $type = null])

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.

addEntry (line 156)

Method to add an entry to the feed object.

since: 12.3
access: public

JFeed addEntry (JFeedEntry $entry)

JFeedEntry $entry: The entry object to add.

offsetExists (line 184)

Whether or not an offset exists. This method is executed when using isset() or empty() on objects implementing ArrayAccess.

see: ArrayAccess::offsetExists()
since: 12.3
access: public

boolean offsetExists (mixed $offset)

mixed $offset: An offset to check for.

Implementation of:

ArrayAccess::offsetExists

offsetGet (line 199)

Returns the value at specified offset.

return: The value at the offset.
see: ArrayAccess::offsetGet()
since: 12.3
access: public

mixed offsetGet (mixed $offset)

mixed $offset: The offset to retrieve.

Implementation of:

ArrayAccess::offsetGet

offsetSet (line 216)

Assigns a value to the specified offset.

see: ArrayAccess::offsetSet()
throws: InvalidArgumentException
since: 12.3
access: public

boolean offsetSet (mixed $offset, JFeedEntry $value)

mixed $offset: The offset to assign the value to.
JFeedEntry $value: The JFeedEntry to set.

Implementation of:

ArrayAccess::offsetSet

offsetUnset (line 238)

Unsets an offset.

see: ArrayAccess::offsetUnset()
since: 12.3
access: public

void offsetUnset (mixed $offset)

mixed $offset: The offset to unset.

Implementation of:

ArrayAccess::offsetUnset

removeCategory (line 252)

Method to remove a category from the feed object.

since: 12.3
access: public

JFeed removeCategory (string $name)

string $name: The name of the category to remove.

removeContributor (line 268)

Method to remove a contributor from the feed object.

since: 12.3
access: public

JFeed removeContributor (JFeedPerson $contributor)

JFeedPerson $contributor: The person object to remove.

removeEntry (line 294)

Method to remove an entry from the feed object.

since: 12.3
access: public

JFeed removeEntry (JFeedEntry $entry)

JFeedEntry $entry: The entry object to remove.

setAuthor (line 323)

Shortcut method to set the author for the feed object.

since: 12.3
access: public

JFeed setAuthor (string $name, string $email, [string $uri = null], [string $type = null])

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.

__get (line 61)

Magic method to return values for feed properties.

since: 12.3
access: public

mixed __get (string $name)

string $name: The name of the property.

__set (line 76)

Magic method to set values for feed properties.

since: 12.3
access: public

void __set (string $name, mixed $value)

string $name: The name of the property.
mixed $value: The value to set for the property.