Class Zend_Feed_Builder_Entry

Description

An entry of a custom build feed

Classes implementing the Zend_Feed_Builder_Interface interface uses this class to describe an entry of a feed

  • copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Feed/Builder/Entry.php (line 41)

ArrayObject
   |
   --Zend_Feed_Builder_Entry
Method Summary
 void __construct (string $title, string $link, string $description)
 Zend_Feed_Builder_Entry addEnclosure (string $url, [string $type = ''], [string $length = ''])
 Zend_Feed_Builder_Entry setContent (string $content)
 Zend_Feed_Builder_Entry setSource (string $title, string $url)
 mixed __get (string $name)
 boolean __isset (string $key)
 void __set (string $name, mixed $value)
 void __unset (string $key)
Methods
Constructor __construct (line 51)

Create a new builder entry

  • access: public
void __construct (string $title, string $link, string $description)
  • string $title
  • string $link
  • string $description: short version of the entry, no html

Redefinition of:
ArrayObject::constructor __construct ( $array )
addCategory (line 215)

Add a category to the entry

  • throws: Zend_Feed_Builder_Exception
  • access: public
Zend_Feed_Builder_Entry addCategory ( $category)
  • array $category: see Zend_Feed_Builder_Entry::setCategories() for format
addEnclosure (line 270)

Add an enclosure to the entry

  • access: public
Zend_Feed_Builder_Entry addEnclosure (string $url, [string $type = ''], [string $length = ''])
  • string $url
  • string $type
  • string $length
setCategories (line 200)

Sets the categories of the entry

Format of the array:

  1.  array(
  2.    array(
  3.          'term' => 'first category label',
  4.          'scheme' => 'url that identifies a categorization scheme' // optional
  5.         ),
  6.    // second category and so one
  7.  )

  • access: public
Zend_Feed_Builder_Entry setCategories ( $categories)
  • array $categories
setCommentsRssUrl (line 164)

Sets the url of the comments feed link

  • access: public
Zend_Feed_Builder_Entry setCommentsRssUrl (string $commentRss)
  • string $commentRss
setCommentsUrl (line 152)

Sets the url of the commented page associated to the entry

  • access: public
Zend_Feed_Builder_Entry setCommentsUrl (string $comments)
  • string $comments
setContent (line 128)

Sets the full html content of the entry

  • access: public
Zend_Feed_Builder_Entry setContent (string $content)
  • string $content
setEnclosures (line 249)

Sets the enclosures of the entry

Format of the array:

  1.  array(
  2.    array(
  3.          'url' => 'url of the linked enclosure',
  4.          'type' => 'mime type of the enclosure' // optional
  5.          'length' => 'length of the linked content in octets' // optional
  6.         ),
  7.    // second enclosure and so one
  8.  )

  • throws: Zend_Feed_Builder_Exception
  • access: public
Zend_Feed_Builder_Entry setEnclosures ( $enclosures)
  • array $enclosures
setId (line 116)

Sets the id/guid of the entry

  • access: public
Zend_Feed_Builder_Entry setId (string $id)
  • string $id
setLastUpdate (line 140)

Timestamp of the update date

  • access: public
Zend_Feed_Builder_Entry setLastUpdate (int $lastUpdate)
  • int $lastUpdate
setSource (line 177)

Defines a reference to the original source

  • access: public
Zend_Feed_Builder_Entry setSource (string $title, string $url)
  • string $title
  • string $url
__get (line 65)

Read only properties accessor

  • access: public
mixed __get (string $name)
  • string $name: property to read
__isset (line 92)

Isset accessor

  • access: public
boolean __isset (string $key)
  • string $key
__set (line 81)

Write properties accessor

  • access: public
void __set (string $name, mixed $value)
  • string $name: name of the property to set
  • mixed $value: value to set
__unset (line 103)

Unset accessor

  • access: public
void __unset (string $key)
  • string $key

Inherited Methods

Inherited From ArrayObject (Internal Class)

 constructor __construct ( $array )
 append ( $value )
 asort ( )
 count ( )
 exchangeArray ( $array )
 getArrayCopy ( )
 getFlags ( )
 getIterator ( )
 getIteratorClass ( )
 ksort ( )
 natcasesort ( )
 natsort ( )
 offsetExists ( $index )
 offsetGet ( $index )
 offsetSet ( $index, $newval )
 offsetUnset ( $index )
 setFlags ( $flags )
 setIteratorClass ( $iteratorClass )
 uasort ( $cmp_function )
 uksort ( $cmp_function )
Class Constants

Inherited Constants

Inherited from ArrayObject (Internal Class)

ARRAY_AS_PROPS = 2
STD_PROP_LIST = 1

Documentation generated on Sun, 27 May 2007 23:23:01 -0700 by phpDocumentor 1.3.2