Feed/Writer/Entry.php

Show:

inherited

Classes
- \Zend_Feed_Writer_Entry

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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Feed_Writer
Version: $Id$

\Zend_Feed_Writer_Entry
jump to top

Package: Zend_Feed_Writer

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

array $_data = array()

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

Default valuearray()Details

Type: array

array $_extensions = array()

Registered extensions

Default valuearray()Details

Type: array

string $_type = null

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

Default valuenullDetails

Type: string

Methods

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

Method overloading: call given method on first extension implementing it

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

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

_loadExtensions() : void

Load extensions from Zend_Feed_Writer

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

Set a single author

Parameters

Name	Type	Description
$name
$email
$uri

Returns

Type	Description
string \| null

addAuthors( $authors) : array

Set an array with feed authors

Parameters

Name	Type	Description
$authors

Returns

Type	Description
array

addCategories(array $categories) : void

Set an array of entry categories

Parameters

Name	Type	Description
$categories	array

addCategory(string $category) : void

Add a entry category

Parameters

Name	Type	Description
$category	string

createSource() : \Zend_Feed_Writer_Source

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.

Returns

Type	Description
\Zend_Feed_Writer_Source

getAuthors() : array

Get an array with feed authors

Returns

Type	Description
array

getCategories() : string | null

Get the entry categories

Returns

Type	Description
string \| null

getCommentCount() : integer

Get the number of comments/replies for current entry

Returns

Type	Description
integer

getCommentFeedLinks() : string

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).

Returns

Type	Description
string

getCommentLink() : string

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

Returns

Type	Description
string

getContent() : string

Get the entry content

Returns

Type	Description
string

getCopyright() : string

Get the entry copyright information

Returns

Type	Description
string

getDateCreated() : string

Get the entry creation date

Returns

Type	Description
string

getDateModified() : string

Get the entry modification date

Returns

Type	Description
string

getDescription() : string

Get the entry description

Returns

Type	Description
string

getEnclosure() : array

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

Returns

Type	Description
array

getEncoding() : string | null

Get the feed character encoding

Returns

Type	Description
string \| null

getExtension(string $name) : object

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

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
object

getExtensions() : array

Get registered extensions

Returns

Type	Description
array

getId() : string

Get the entry ID

Returns

Type	Description
string

getLink() : string | null

Get a link to the HTML source

Returns

Type	Description
string \| null

getLinks() : array

Get all links

Returns

Type	Description
array

getSource() : \Zend_Feed_Writer_Source

Returns

Type	Description
\Zend_Feed_Writer_Source

getTitle() : string

Get the entry title

Returns

Type	Description
string

getType() : string

Retrieve the current or last feed type exported.

Returns

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

remove(string $name) : void

Unset a specific data point

Parameters

Name	Type	Description
$name	string

setCommentCount( $count) : string | null

Set the number of comments associated with this entry

Parameters

Name	Type	Description
$count

Returns

Type	Description
string \| null

setCommentFeedLink( $link) : string | null

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

Parameters

Name	Type	Description
$link

Returns

Type	Description
string \| null

setCommentFeedLinks( $links) : string | null

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

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

Parameters

Name	Type	Description
$links

Returns

Type	Description
string \| null

setCommentLink( $link) : string | null

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

Parameters

Name	Type	Description
$link

Returns

Type	Description
string \| null

setContent( $content) : string | null

Set the entry's content

Parameters

Name	Type	Description
$content

Returns

Type	Description
string \| null

setCopyright( $copyright) : string | null

Set the copyright entry

Parameters

Name	Type	Description
$copyright

Returns

Type	Description
string \| null

setDateCreated( $date = null) : string | null

Set the feed creation date

Parameters

Name	Type	Description
$date

Returns

Type	Description
string \| null

setDateModified( $date = null) : string | null

Set the feed modification date

Parameters

Name	Type	Description
$date

Returns

Type	Description
string \| null

setDescription( $description) : string | null

Set the feed description

Parameters

Name	Type	Description
$description

Returns

Type	Description
string \| null

setEnclosure( $enclosure) : void

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.

Parameters

Name	Type	Description
$enclosure

setEncoding( $encoding) : string | null

Set the feed character encoding

Parameters

Name	Type	Description
$encoding

Returns

Type	Description
string \| null

setId( $id) : string | null

Set the feed ID

Parameters

Name	Type	Description
$id

Returns

Type	Description
string \| null

setLink( $link) : string | null

Set a link to the HTML source of this entry

Parameters

Name	Type	Description
$link

Returns

Type	Description
string \| null

setSource(\Zend_Feed_Writer_Source $source) : 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
$source	\Zend_Feed_Writer_Source

setTitle( $title) : string | null

Set the feed title

Parameters

Name	Type	Description
$title

Returns

Type	Description
string \| null

setType(string $type) : void

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

Name	Type	Description
$type	string

Feed/Writer/Entry.php

\Zend_Feed_Writer_Entryjump to top

Properties

Methods

\Zend_Feed_Writer_Entry
jump to top