PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of Feed.php

Joomla! Content Management System

Copyright:	(C) 2012 Open Source Matters, Inc.
License:	GNU General Public License version 2 or later; see LICENSE.txt
File Size:	375 lines (11 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

Feed:: (15 methods):
  __get()
  __set()
  addCategory()
  addContributor()
  addEntry()
  count()
  offsetExists()
  offsetGet()
  offsetSet()
  offsetUnset()
  removeCategory()
  removeContributor()
  removeEntry()
  setAuthor()
  reverseItems()

Class: Feed - X-Ref

Class to encapsulate a feed for the Joomla Platform.

__get($name) X-Ref

Magic method to return values for feed properties.

param: string $name The name of the property.
return: mixed

__set($name, $value) X-Ref

Magic method to set values for feed properties.

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

addCategory($name, $uri = '') X-Ref

Method to add a category to the feed object.

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

addContributor($name, $email, $uri = null, $type = null) X-Ref

Method to add a contributor to the feed object.

param: string  $name   The full name of the person to add.
param: string  $email  The email address of the person to add.
param: string  $uri    The optional URI for the person to add.
param: string  $type   The optional type of person to add.
return: Feed

addEntry(FeedEntry $entry) X-Ref

Method to add an entry to the feed object.

param: FeedEntry $entry The entry object to add.
return: Feed

count() X-Ref

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();

return: integer number of entries in the feed.

offsetExists($offset) X-Ref

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

param: mixed $offset An offset to check for.
return: boolean

offsetGet($offset) X-Ref

Returns the value at specified offset.

param: mixed $offset The offset to retrieve.
return: mixed The value at the offset.

offsetSet($offset, $value) X-Ref

Assigns a value to the specified offset.

param: mixed $offset The offset to assign the value to.
param: FeedEntry $value The JFeedEntry to set.
return: boolean

offsetUnset($offset) X-Ref

Unsets an offset.

param: mixed $offset The offset to unset.
return: void

removeCategory($name) X-Ref

Method to remove a category from the feed object.

param: string $name The name of the category to remove.
return: Feed

removeContributor(FeedPerson $contributor) X-Ref

Method to remove a contributor from the feed object.

param: FeedPerson $contributor The person object to remove.
return: Feed

removeEntry(FeedEntry $entry) X-Ref

Method to remove an entry from the feed object.

param: FeedEntry $entry The entry object to remove.
return: Feed

setAuthor($name, $email, $uri = null, $type = null) X-Ref

Shortcut method to set the author for the feed object.

param: string  $name   The full name of the person to set.
param: string  $email  The email address of the person to set.
param: string  $uri    The optional URI for the person to set.
param: string  $type   The optional type of person to set.
return: Feed

reverseItems() X-Ref

Method to reverse the items if display is set to 'oldest first'

return: Feed

PHP Cross Reference of Joomla 4.2.2 documentation

/libraries/src/Feed/ -> Feed.php (summary)

Defines 1 class