Zend Framework API Documentation » \Zend_Feed_Writer

category	Zend
package	Zend_Feed_Writer
copyright	Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license	New BSD License

Methods

Method overloading: call given method on first extension implementing it

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

Parameters

$method

string

$args

array

Exceptions

`\Zend_Feed_Exception`	if no extensions implements the method

Returns

mixed

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

__construct() : void

Set a single author

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

Parameters

$name

$email

$uri

Returns

stringnull

Set an array with feed authors

addAuthors(array $authors) : array

Parameters

$authors

Returns

array

Set an array of entry categories

addCategories(array $categories)

Parameters

$categories

array

Add a entry category

addCategory(string $category)

Parameters

$category

string

Creates a new Zend_Feed_Writer_Source 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.

createSource() : \Zend_Feed_Writer_Source

Returns

\Zend_Feed_Writer_Source

Get an array with feed authors

getAuthors() : array

Returns

array

Get the entry categories

getCategories() : string | null

Returns

stringnull

Get the number of comments/replies for current entry

getCommentCount() : integer

Returns

integer

Returns an array of URIs pointing to a feed of all comments for this entry where the array keys indicate the feed type (atom, rss or rdf).

getCommentFeedLinks() : string

Returns

string

Returns a URI pointing to the HTML page where comments can be made on this entry

getCommentLink() : string

Returns

string

Get the entry content

getContent() : string

Returns

string

Get the entry copyright information

getCopyright() : string

Returns

string

Get the entry creation date

getDateCreated() : string

Returns

string

Get the entry modification date

getDateModified() : string

Returns

string

Get the entry description

getDescription() : string

Returns

string

Retrieve an array of all enclosures to be added to entry.

getEnclosure() : array

Returns

array

Get the feed character encoding

getEncoding() : string | null

Returns

stringnull

Return an Extension object with the matching name (postfixed with _Entry)

getExtension(string $name) : object

Parameters

$name

string

Returns

object

Get registered extensions

getExtensions() : array

Returns

array

Get the entry ID

getId() : string

Returns

string

Get a link to the HTML source

getLink() : string | null

Returns

stringnull

Get all links

getLinks() : array

Returns

array

getSource()

getSource() : \Zend_Feed_Writer_Source

Returns

\Zend_Feed_Writer_Source

Get the entry title

getTitle() : string

Returns

string

Retrieve the current or last feed type exported.

getType() : string

Returns

stringValue will be "rss" or "atom"

Unset a specific data point

remove(string $name)

Parameters

$name

string

Set the number of comments associated with this entry

setCommentCount($count) : string | null

Parameters

$count

Returns

stringnull

Set a link to an XML feed for any comments associated with this entry

setCommentFeedLink(array $link) : string | null

Parameters

$link

Returns

stringnull

Set a links to an XML feed for any comments associated with this entry.

setCommentFeedLinks(array $links) : string | null

Each link is an array with keys "uri" and "type", where type is one of: "atom", "rss" or "rdf".

Parameters

$links

Returns

stringnull

Set a link to a HTML page containing comments associated with this entry

setCommentLink($link) : string | null

Parameters

$link

Returns

stringnull

Set the entry's content

setContent($content) : string | null

Parameters

$content

Returns

stringnull

Set the copyright entry

setCopyright($copyright) : string | null

Parameters

$copyright

Returns

stringnull

Set the feed creation date

setDateCreated($date = null) : string | null

Parameters

$date

Returns

stringnull

Set the feed modification date

setDateModified($date = null) : string | null

Parameters

$date

Returns

stringnull

Set the feed description

setDescription($description) : string | null

Parameters

$description

Returns

stringnull

Adds an enclosure to the entry. The array parameter may contain the keys 'uri', 'type' and 'length'. Only 'uri' is required for Atom, though the others must also be provided or RSS rendering (where they are required) will throw an Exception.

setEnclosure(array $enclosure)

Parameters

$enclosure

Set the feed character encoding

setEncoding($encoding) : string | null

Parameters

$encoding

Returns

stringnull

Set the feed ID

setId($id) : string | null

Parameters

$id

Returns

stringnull

Set a link to the HTML source of this entry

setLink($link) : string | null

Parameters

$link

Returns

stringnull

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

setSource(\Zend_Feed_Writer_Source $source)

Parameters

$source

\Zend_Feed_Writer_Source

Set the feed title

setTitle($title) : string | null

Parameters

$title

Returns

stringnull

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.

setType(string $type)

Parameters

$type

string

Load extensions from Zend_Feed_Writer

_loadExtensions() : void

Properties

Internal array containing all data associated with this entry or item.

$_data : array

Default

array()

Registered extensions

$_extensions : array

Default

array()

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

$_type : string

Default

null