Public Member Functions
	__construct ()
	Constructor: Primarily triggers the registration of core extensions and loads those appropriate to this data container.

	addAuthor ($name, $email=null, $uri=null)
	Set a single author.

	addAuthors (array $authors)
	Set an array with feed authors.

	setCopyright ($copyright)
	Set the copyright entry.

	setDateCreated ($date=null)
	Set the feed creation date.

	setDateModified ($date=null)
	Set the feed modification date.

	setLastBuildDate ($date=null)
	Set the feed last-build date.

	setDescription ($description)
	Set the feed description.

	setGenerator ($name, $version=null, $uri=null)
	Set the feed generator entry.

	setId ($id)
	Set the feed ID - URI or URN (via PCRE pattern) supported.

	setImage (array $data)
	Set a feed image (URI at minimum).

	setIcon (array $data)
	Set a feed icon (URI at minimum).

	setLanguage ($language)
	Set the feed language.

	setLink ($link)
	Set a link to the HTML source.

	setFeedLink ($link, $type)
	Set a link to an XML feed for any feed type/version.

	setTitle ($title)
	Set the feed title.

	setEncoding ($encoding)
	Set the feed character encoding.

	setBaseUrl ($url)
	Set the feed's base URL.

	addHub ($url)
	Add a Pubsubhubbub hub endpoint URL.

	addHubs (array $urls)
	Add Pubsubhubbub hub endpoint URLs.

	addCategory (array $category)
	Add a feed category.

	addCategories (array $categories)
	Set an array of feed categories.

	getAuthor ($index=0)
	Get a single author.

	getAuthors ()
	Get an array with feed authors.

	getCopyright ()
	Get the copyright entry.

	getDateCreated ()
	Get the feed creation date.

	getDateModified ()
	Get the feed modification date.

	getLastBuildDate ()
	Get the feed last-build date.

	getDescription ()
	Get the feed description.

	getGenerator ()
	Get the feed generator entry.

	getId ()
	Get the feed ID.

	getImage ()
	Get the feed image URI.

	getIcon ()
	Get the feed icon URI.

	getLanguage ()
	Get the feed language.

	getLink ()
	Get a link to the HTML source.

	getFeedLinks ()
	Get a link to the XML feed.

	getTitle ()
	Get the feed title.

	getEncoding ()
	Get the feed character encoding.

	getBaseUrl ()
	Get the feed's base url.

	getHubs ()
	Get the URLs used as Pubsubhubbub hubs endpoints.

	getCategories ()
	Get the feed categories.

	reset ()
	Resets the instance and deletes all data.

	setType ($type)
	Set the current feed type being exported to "rss" or "atom".

	getType ()
	Retrieve the current or last feed type exported.

	remove ($name)
	Unset a specific data point.

	__call ($method, $args)
	Method overloading: call given method on first extension implementing it.

Protected Member Functions
	_validateTagUri ($id)
	Validate a URI using the tag scheme (RFC 4151)

	_loadExtensions ()
	Load extensions from Zend_Feed_Writer.

Protected Attributes
	$_data = array()

	$_type = null

Constructor & Destructor Documentation

__construct ( )

Constructor: Primarily triggers the registration of core extensions and loads those appropriate to this data container.

Returns: void

Member Function Documentation

__call	(	$method,
		$args
	)

Method overloading: call given method on first extension implementing it.

Parameters

string	$method
array	$args

Returns: mixed

Exceptions

Zend_Feed_Exception if no extensions implements the method

_loadExtensions ( )

protected

Load extensions from Zend_Feed_Writer.

Returns: void

_validateTagUri ( $id )

protected

Validate a URI using the tag scheme (RFC 4151)

Parameters

string $id

Returns: bool

addAuthor	(	$name,
		$email = `null`,
		$uri = `null`
	)

Set a single author.

Parameters

int $index

Returns: string|null

addAuthors ( array $authors )

Set an array with feed authors.

Returns: array

addCategories ( array $categories )

Set an array of feed categories.

Parameters

array $categories

addCategory ( array $category )

Add a feed category.

Parameters

string $category

addHub ( $url )

Add a Pubsubhubbub hub endpoint URL.

Parameters

string $url

addHubs ( array $urls )

Add Pubsubhubbub hub endpoint URLs.

Parameters

array $urls

getAuthor ( $index = 0 )

Get a single author.

Parameters

int $index

Returns: string|null

getAuthors ( )

Get an array with feed authors.

Returns: array

getBaseUrl ( )

Get the feed's base url.

Returns: string|null

getCategories ( )

Get the feed categories.

Returns: string|null

getCopyright ( )

Get the copyright entry.

Returns: string|null

getDateCreated ( )

Get the feed creation date.

Returns: string|null

getDateModified ( )

Get the feed modification date.

Returns: string|null

getDescription ( )

Get the feed description.

Returns: string|null

getEncoding ( )

Get the feed character encoding.

Returns: string|null

getFeedLinks ( )

Get a link to the XML feed.

Returns: string|null

getGenerator ( )

Get the feed generator entry.

Returns: string|null

getHubs ( )

Get the URLs used as Pubsubhubbub hubs endpoints.

Returns: string|null

getIcon ( )

Get the feed icon URI.

Returns: array

getId ( )

Get the feed ID.

Returns: string|null

getImage ( )

Get the feed image URI.

Returns: array

getLanguage ( )

Get the feed language.

Returns: string|null

getLastBuildDate ( )

Get the feed last-build date.

Returns: string|null

getLink ( )

Get a link to the HTML source.

Returns: string|null

getTitle ( )

Get the feed title.

Returns: string|null

getType ( )

Retrieve the current or last feed type exported.

Returns: string Value will be "rss" or "atom"

remove ( $name )

Unset a specific data point.

Parameters

string $name

reset ( )

Resets the instance and deletes all data.

Returns: void

setBaseUrl ( $url )

Set the feed's base URL.

Parameters

string $url

setCopyright ( $copyright )

Set the copyright entry.

Returns: string|null

setDateCreated ( $date = null )

Set the feed creation date.

Parameters

null|integer|Zend_Date

setDateModified ( $date = null )

Set the feed modification date.

Parameters

null|integer|Zend_Date

setDescription ( $description )

Set the feed description.

Returns: string|null

setEncoding ( $encoding )

Set the feed character encoding.

Parameters

string $encoding

setFeedLink	(	$link,
		$type
	)

Set a link to an XML feed for any feed type/version.

Returns: string|null

setGenerator	(	$name,
		$version = `null`,
		$uri = `null`
	)

Set the feed generator entry.

Returns: string|null

setIcon ( array $data )

Set a feed icon (URI at minimum).

Parameter is a single array with the required key 'uri'. Only 'uri' is required and used for Atom rendering. RSS does not support an Icon tag except via Atom 1.0 as an extension.

Parameters

array $data

setId ( $id )

Set the feed ID - URI or URN (via PCRE pattern) supported.

Parameters

string $id

setImage ( array $data )

Set a feed image (URI at minimum).

Parameter is a single array with the required key 'uri'. When rendering as RSS, the required keys are 'uri', 'title' and 'link'. RSS also specifies three optional parameters 'width', 'height' and 'description'. Only 'uri' is required and used for Atom rendering.

Parameters

array $data

setLanguage ( $language )

Set the feed language.

Returns: string|null

setLastBuildDate ( $date = null )

Set the feed last-build date.

Ignored for Atom 1.0.

Parameters

null|integer|Zend_Date

setLink ( $link )

Set a link to the HTML source.

Parameters

string $link

setTitle ( $title )

Set the feed title.

Returns: string|null

setType ( $type )

Set the current feed type being exported to "rss" or "atom".

This allows other objects to gracefully choose whether to execute or not, depending on their appropriateness for the current type, e.g. renderers.

Parameters

string $type

Member Data Documentation

$_data = array()

protected

$_type = null

protected

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation