Feed/Writer/Feed.php

Show:

inherited

Classes
- \Zend_Feed_Writer_Feed

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Feed_Writer
Version: $Id: Feed.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Feed_Writer_Feed
jump to top

Package: Zend\Feed\Writer

Implements
Parent(s): \Zend_Feed_Writer_Feed_FeedAbstract
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

array $_data = array()

inherited

Contains all Feed level date to append in feed output

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::$$_data

Default valuearray()Details

Type: array
Inherited_from: \Zend_Feed_Writer_Feed_FeedAbstract::$$_data

array $_entries = array()

Contains all entry objects

Default valuearray()Details

Type: array

int $_entriesKey = 0

A pointer for the iterator to keep track of the entries array

Default value0Details

Type: int

string $_type = null

inherited

Holds the value "atom" or "rss" depending on the feed type set when when last exported.

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::$$_type

Default valuenullDetails

Type: string
Inherited_from: \Zend_Feed_Writer_Feed_FeedAbstract::$$_type

Methods

__call(string $method, array $args) : mixed

inherited

Method overloading: call given method on first extension implementing it

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::__call()

Parameters

Name	Type	Description
$method	string
$args	array

Returns

Type	Description
mixed

Throws

Exception	Description
\Zend_Feed_Exception	if no extensions implements the method

__construct() : void

inherited

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

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::__construct()

_loadExtensions() : void

inherited

Load extensions from Zend_Feed_Writer

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::_loadExtensions()

_validateTagUri(string $id) : bool

inherited

Validate a URI using the tag scheme (RFC 4151)

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::_validateTagUri()

Parameters

Name	Type	Description
$id	string

Returns

Type	Description
bool

addAuthor( $name, $email = null, $uri = null) : string | null

inherited

Set a single author

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::addAuthor()

Parameters

Name	Type	Description
$name
$email
$uri

Returns

Type	Description
string \| null

addAuthors( $authors) : array

inherited

Set an array with feed authors

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::addAuthors()

Parameters

Name	Type	Description
$authors

Returns

Type	Description
array

addCategories(array $categories) : void

inherited

Set an array of feed categories

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::addCategories()

Parameters

Name	Type	Description
$categories	array

addCategory(string $category) : void

inherited

Add a feed category

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::addCategory()

Parameters

Name	Type	Description
$category	string

addEntry(\Zend_Feed_Writer_Entry $entry) : void

Appends a Zend_Feed_Writer_Entry object representing a new entry/item the feed data container's internal group of entries.

Parameters

Name	Type	Description
$entry	\Zend_Feed_Writer_Entry

addHub(string $url) : void

inherited

Add a Pubsubhubbub hub endpoint URL

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::addHub()

Parameters

Name	Type	Description
$url	string

addHubs(array $urls) : void

inherited

Add Pubsubhubbub hub endpoint URLs

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::addHubs()

Parameters

Name	Type	Description
$urls	array

addTombstone( $deleted) : void

Appends a Zend_Feed_Writer_Deleted object representing a new entry tombstone to the feed data container's internal group of entries.

Parameters

Name	Type	Description
$deleted

count() : int

Get the number of feed entries.

Required by the Iterator interface.

Returns

Type	Description
int

createEntry() : \Zend_Feed_Writer_Entry

Creates a new Zend_Feed_Writer_Entry data container for use.

This is NOT added to the current feed automatically, but is necessary to create a container with some initial values preset based on the current feed data.

Returns

Type	Description
\Zend_Feed_Writer_Entry

createTombstone() : \Zend_Feed_Writer_Deleted

Creates a new Zend_Feed_Writer_Deleted data container for use.

This is NOT added to the current feed automatically, but is necessary to create a container with some initial values preset based on the current feed data.

Returns

Type	Description
\Zend_Feed_Writer_Deleted

current() : \Zend_Feed_Reader_Entry_Interface

Return the current entry

Returns

Type	Description
\Zend_Feed_Reader_Entry_Interface

export(string $type, bool $ignoreExceptions = false) : string

Attempt to build and return the feed resulting from the data set

Parameters

Name	Type	Description
$type	string	The feed type "rss" or "atom" to export as
$ignoreExceptions	bool

Returns

Type	Description
string

getAuthor(int $index = 0) : string | null

inherited

Get a single author

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getAuthor()

Parameters

Name	Type	Description
$index	int

Returns

Type	Description
string \| null

getAuthors() : array

inherited

Get an array with feed authors

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getAuthors()

Returns

Type	Description
array

getBaseUrl() : string | null

inherited

Get the feed's base url

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getBaseUrl()

Returns

Type	Description
string \| null

getCategories() : string | null

inherited

Get the feed categories

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getCategories()

Returns

Type	Description
string \| null

getCopyright() : string | null

inherited

Get the copyright entry

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getCopyright()

Returns

Type	Description
string \| null

getDateCreated() : string | null

inherited

Get the feed creation date

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getDateCreated()

Returns

Type	Description
string \| null

getDateModified() : string | null

inherited

Get the feed modification date

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getDateModified()

Returns

Type	Description
string \| null

getDescription() : string | null

inherited

Get the feed description

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getDescription()

Returns

Type	Description
string \| null

getEncoding() : string | null

inherited

Get the feed character encoding

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getEncoding()

Returns

Type	Description
string \| null

getEntry(int $index = 0) : void

Retrieve a specific indexed entry from the internal queue.

Entries must be added to a feed container in order to be indexed.

Parameters

Name	Type	Description
$index	int

getFeedLinks() : string | null

inherited

Get a link to the XML feed

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getFeedLinks()

Returns

Type	Description
string \| null

getGenerator() : string | null

inherited

Get the feed generator entry

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getGenerator()

Returns

Type	Description
string \| null

getHubs() : string | null

inherited

Get the URLs used as Pubsubhubbub hubs endpoints

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getHubs()

Returns

Type	Description
string \| null

getIcon() : array

inherited

Get the feed icon URI

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getIcon()

Returns

Type	Description
array

getId() : string | null

inherited

Get the feed ID

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getId()

Returns

Type	Description
string \| null

getImage() : array

inherited

Get the feed image URI

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getImage()

Returns

Type	Description
array

getLanguage() : string | null

inherited

Get the feed language

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getLanguage()

Returns

Type	Description
string \| null

getLastBuildDate() : string | null

inherited

Get the feed last-build date

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getLastBuildDate()

Returns

Type	Description
string \| null

getLink() : string | null

inherited

Get a link to the HTML source

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getLink()

Returns

Type	Description
string \| null

getTitle() : string | null

inherited

Get the feed title

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getTitle()

Returns

Type	Description
string \| null

getType() : string

inherited

Retrieve the current or last feed type exported.

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::getType()

Returns

Type	Description
string	Value will be "rss" or "atom"

key() : \unknown

Return the current feed key

Returns

Type	Description
\unknown

next() : void

Move the feed pointer forward

orderByDate() : void

Orders all indexed entries by date, thus offering date ordered readable content where a parser (or Homo Sapien) ignores the generic rule that XML element order is irrelevant and has no intrinsic meaning.

Using this method will alter the original indexation.

remove(string $name) : void

inherited

Unset a specific data point

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::remove()

Parameters

Name	Type	Description
$name	string

removeEntry(int $index) : void

Removes a specific indexed entry from the internal queue.

Entries must be added to a feed container in order to be indexed.

Parameters

Name	Type	Description
$index	int

reset() : void

inherited

Resets the instance and deletes all data

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::reset()

rewind() : void

Reset the pointer in the feed object

setBaseUrl(string $url) : void

inherited

Set the feed's base URL

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setBaseUrl()

Parameters

Name	Type	Description
$url	string

setCopyright( $copyright) : string | null

inherited

Set the copyright entry

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setCopyright()

Parameters

Name	Type	Description
$copyright

Returns

Type	Description
string \| null

setDateCreated(null | integer | \Zend_Date $date = null) : void

inherited

Set the feed creation date

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setDateCreated()

Parameters

Name	Type	Description
$date	null \| integer \| \Zend_Date

setDateModified(null | integer | \Zend_Date $date = null) : void

inherited

Set the feed modification date

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setDateModified()

Parameters

Name	Type	Description
$date	null \| integer \| \Zend_Date

setDescription( $description) : string | null

inherited

Set the feed description

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setDescription()

Parameters

Name	Type	Description
$description

Returns

Type	Description
string \| null

setEncoding(string $encoding) : void

inherited

Set the feed character encoding

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setEncoding()

Parameters

Name	Type	Description
$encoding	string

setFeedLink( $link, $type) : string | null

inherited

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

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setFeedLink()

Parameters

Name	Type	Description
$link
$type

Returns

Type	Description
string \| null

setGenerator( $name, $version = null, $uri = null) : string | null

inherited

Set the feed generator entry

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setGenerator()

Parameters

Name	Type	Description
$name
$version
$uri

Returns

Type	Description
string \| null

setIcon(array $data) : void

inherited

Set a feed icon (URI at minimum).

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setIcon()

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

Name	Type	Description
$data	array

setId(string $id) : void

inherited

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

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setId()

Parameters

Name	Type	Description
$id	string

setImage(array $data) : void

inherited

Set a feed image (URI at minimum).

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setImage()

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

Name	Type	Description
$data	array

setLanguage( $language) : string | null

inherited

Set the feed language

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setLanguage()

Parameters

Name	Type	Description
$language

Returns

Type	Description
string \| null

setLastBuildDate(null | integer | \Zend_Date $date = null) : void

inherited

Set the feed last-build date.

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setLastBuildDate()

Ignored for Atom 1.0.

Parameters

Name	Type	Description
$date	null \| integer \| \Zend_Date

setLink(string $link) : void

inherited

Set a link to the HTML source

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setLink()

Parameters

Name	Type	Description
$link	string

setTitle( $title) : string | null

inherited

Set the feed title

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setTitle()

Parameters

Name	Type	Description
$title

Returns

Type	Description
string \| null

setType(string $type) : void

inherited

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

Inherited from: \Zend_Feed_Writer_Feed_FeedAbstract::setType()

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

Parameters

Name	Type	Description
$type	string

valid() : boolean

Check to see if the iterator is still valid

Returns

Type	Description
boolean

Feed/Writer/Feed.php

\Zend_Feed_Writer_Feedjump to top

Properties

Methods

\Zend_Feed_Writer_Feed
jump to top