Zend Framework  1.12
Public Member Functions | List of all members
Zend_Feed_Builder_Entry Class Reference

Public Member Functions

 __construct ($title, $link, $description)
 Create a new builder entry.
 
 __get ($name)
 Read only properties accessor.
 
 __set ($name, $value)
 Write properties accessor.
 
 __isset ($key)
 Isset accessor.
 
 __unset ($key)
 Unset accessor.
 
 setAuthor ($author)
 Sets the author of the entry.
 
 setId ($id)
 Sets the id/guid of the entry.
 
 setContent ($content)
 Sets the full html content of the entry.
 
 setLastUpdate ($lastUpdate)
 Timestamp of the update date.
 
 setCommentsUrl ($comments)
 Sets the url of the commented page associated to the entry.
 
 setCommentsRssUrl ($commentRss)
 Sets the url of the comments feed link.
 
 setSource ($title, $url)
 Defines a reference to the original source.
 
 setCategories (array $categories)
 Sets the categories of the entry Format of the array: array( array( 'term' => 'first category label', 'scheme' => 'url that identifies a categorization scheme' // optional ), // second category and so one )
 
 addCategory (array $category)
 Add a category to the entry.
 
 setEnclosures (array $enclosures)
 Sets the enclosures of the entry Format of the array: array( array( 'url' => 'url of the linked enclosure', 'type' => 'mime type of the enclosure' // optional 'length' => 'length of the linked content in octets' // optional ), // second enclosure and so one )
 
 addEnclosure ($url, $type= '', $length= '')
 Add an enclosure to the entry.
 

Constructor & Destructor Documentation

__construct (   $title,
  $link,
  $description 
)

Create a new builder entry.

Parameters
string$title
string$link
string$descriptionshort version of the entry, no html
Returns
void

Member Function Documentation

__get (   $name)

Read only properties accessor.

Parameters
string$nameproperty to read
Returns
mixed
__isset (   $key)

Isset accessor.

Parameters
string$key
Returns
boolean
__set (   $name,
  $value 
)

Write properties accessor.

Parameters
string$namename of the property to set
mixed$valuevalue to set
Returns
void
__unset (   $key)

Unset accessor.

Parameters
string$key
Returns
void
addCategory ( array  $category)

Add a category to the entry.

Parameters
array$categorysee Zend_Feed_Builder_Entry::setCategories() for format
Returns
Zend_Feed_Builder_Entry
Exceptions
Zend_Feed_Builder_Exception
See Also
Zend_Feed_Builder_Exception
addEnclosure (   $url,
  $type = '',
  $length = '' 
)

Add an enclosure to the entry.

Parameters
string$url
string$type
string$length
Returns
Zend_Feed_Builder_Entry
setAuthor (   $author)

Sets the author of the entry.

Parameters
string$author
Returns
Zend_Feed_Builder_Entry
setCategories ( array  $categories)

Sets the categories of the entry Format of the array: array( array( 'term' => 'first category label', 'scheme' => 'url that identifies a categorization scheme' // optional ), // second category and so one )

Parameters
array$categories
Returns
Zend_Feed_Builder_Entry
setCommentsRssUrl (   $commentRss)

Sets the url of the comments feed link.

Parameters
string$commentRss
Returns
Zend_Feed_Builder_Entry
setCommentsUrl (   $comments)

Sets the url of the commented page associated to the entry.

Parameters
string$comments
Returns
Zend_Feed_Builder_Entry
setContent (   $content)

Sets the full html content of the entry.

Parameters
string$content
Returns
Zend_Feed_Builder_Entry
setEnclosures ( array  $enclosures)

Sets the enclosures of the entry Format of the array: array( array( 'url' => 'url of the linked enclosure', 'type' => 'mime type of the enclosure' // optional 'length' => 'length of the linked content in octets' // optional ), // second enclosure and so one )

Parameters
array$enclosures
Returns
Zend_Feed_Builder_Entry
Exceptions
Zend_Feed_Builder_Exception
See Also
Zend_Feed_Builder_Exception
setId (   $id)

Sets the id/guid of the entry.

Parameters
string$id
Returns
Zend_Feed_Builder_Entry
setLastUpdate (   $lastUpdate)

Timestamp of the update date.

Parameters
int$lastUpdate
Returns
Zend_Feed_Builder_Entry
setSource (   $title,
  $url 
)

Defines a reference to the original source.

Parameters
string$title
string$url
Returns
Zend_Feed_Builder_Entry