Zend Framework  1.12
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_Feed_Writer_Entry Class Reference

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.
 
 setEncoding ($encoding)
 Set the feed character encoding.
 
 getEncoding ()
 Get the feed character encoding.
 
 setCopyright ($copyright)
 Set the copyright entry.
 
 setContent ($content)
 Set the entry's content.
 
 setDateCreated ($date=null)
 Set the feed creation date.
 
 setDateModified ($date=null)
 Set the feed modification date.
 
 setDescription ($description)
 Set the feed description.
 
 setId ($id)
 Set the feed ID.
 
 setLink ($link)
 Set a link to the HTML source of this entry.
 
 setCommentCount ($count)
 Set the number of comments associated with this entry.
 
 setCommentLink ($link)
 Set a link to a HTML page containing comments associated with this entry.
 
 setCommentFeedLink (array $link)
 Set a link to an XML feed for any comments associated with this entry.
 
 setCommentFeedLinks (array $links)
 Set a links to an XML feed for any comments associated with this entry.
 
 setTitle ($title)
 Set the feed title.
 
 getAuthors ()
 Get an array with feed authors.
 
 getContent ()
 Get the entry content.
 
 getCopyright ()
 Get the entry copyright information.
 
 getDateCreated ()
 Get the entry creation date.
 
 getDateModified ()
 Get the entry modification date.
 
 getDescription ()
 Get the entry description.
 
 getId ()
 Get the entry ID.
 
 getLink ()
 Get a link to the HTML source.
 
 getLinks ()
 Get all links.
 
 getTitle ()
 Get the entry title.
 
 getCommentCount ()
 Get the number of comments/replies for current entry.
 
 getCommentLink ()
 Returns a URI pointing to the HTML page where comments can be made on this entry.
 
 getCommentFeedLinks ()
 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).
 
 addCategory (array $category)
 Add a entry category.
 
 addCategories (array $categories)
 Set an array of entry categories.
 
 getCategories ()
 Get the entry categories.
 
 setEnclosure (array $enclosure)
 Adds an enclosure to the entry.
 
 getEnclosure ()
 Retrieve an array of all enclosures to be added to entry.
 
 remove ($name)
 Unset a specific data point.
 
 getExtensions ()
 Get registered extensions.
 
 getExtension ($name)
 Return an Extension object with the matching name (postfixed with _Entry)
 
 setType ($type)
 Set the current feed type being exported to "rss" or "atom".
 
 getType ()
 Retrieve the current or last feed type exported.
 
 __call ($method, $args)
 Method overloading: call given method on first extension implementing it.
 
 createSource ()
 Creates a new Zend_Feed_Writer_Source data container for use.
 
 setSource (Zend_Feed_Writer_Source $source)
 Appends a Zend_Feed_Writer_Entry object representing a new entry/item the feed data container's internal group of entries.
 
 getSource ()
 

Protected Member Functions

 _loadExtensions ()
 Load extensions from Zend_Feed_Writer.
 

Protected Attributes

 $_data = array()
 
 $_extensions = 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_Exceptionif no extensions implements the method
_loadExtensions ( )
protected

Load extensions from Zend_Feed_Writer.

Returns
void
addAuthor (   $name,
  $email = null,
  $uri = null 
)

Set a single author.

Parameters
int$index
Returns
string|null
Deprecated:
Array notation (above) is preferred and will be the sole supported input from ZF 2.0
addAuthors ( array  $authors)

Set an array with feed authors.

Returns
array
addCategories ( array  $categories)

Set an array of entry categories.

Parameters
array$categories
addCategory ( array  $category)

Add a entry category.

Parameters
string$category
createSource ( )

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
Zend_Feed_Writer_Source
getAuthors ( )

Get an array with feed authors.

Returns
array
getCategories ( )

Get the entry categories.

Returns
string|null
getCommentCount ( )

Get the number of comments/replies for current entry.

Returns
integer
getCommentFeedLinks ( )

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
string
getCommentLink ( )

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

Returns
string
getContent ( )

Get the entry content.

Returns
string
getCopyright ( )

Get the entry copyright information.

Returns
string
getDateCreated ( )

Get the entry creation date.

Returns
string
getDateModified ( )

Get the entry modification date.

Returns
string
getDescription ( )

Get the entry description.

Returns
string
getEnclosure ( )

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

Returns
array
getEncoding ( )

Get the feed character encoding.

Returns
string|null
getExtension (   $name)

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

Parameters
string$name
Returns
object
getExtensions ( )

Get registered extensions.

Returns
array
getId ( )

Get the entry ID.

Returns
string
getLink ( )

Get a link to the HTML source.

Returns
string|null
getLinks ( )

Get all links.

Returns
array
getSource ( )
Returns
Zend_Feed_Writer_Source
getTitle ( )

Get the entry title.

Returns
string
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
setCommentCount (   $count)

Set the number of comments associated with this entry.

Returns
string|null
setCommentFeedLink ( array  $link)

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

Returns
string|null
setCommentFeedLinks ( array  $links)

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

Returns
string|null
setCommentLink (   $link)

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

Returns
string|null
setContent (   $content)

Set the entry's content.

Returns
string|null
setCopyright (   $copyright)

Set the copyright entry.

Returns
string|null
setDateCreated (   $date = null)

Set the feed creation date.

Returns
string|null
setDateModified (   $date = null)

Set the feed modification date.

Returns
string|null
setDescription (   $description)

Set the feed description.

Returns
string|null
setEnclosure ( array  $enclosure)

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
array$enclosures
setEncoding (   $encoding)

Set the feed character encoding.

Returns
string|null
setId (   $id)

Set the feed ID.

Returns
string|null
setLink (   $link)

Set a link to the HTML source of this entry.

Returns
string|null
setSource ( Zend_Feed_Writer_Source  $source)

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

Parameters
Zend_Feed_Writer_Source$source
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
$_extensions = array()
protected
$_type = null
protected
Generated by   doxygen 1.8.3