Class Zend_Feed_Builder_Header

Description
Description | Methods (details) Constants

Header of a custom build feed

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

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

Located in /Feed/Builder/Header.php (line 45) 

ArrayObject
   |
   --Zend_Feed_Builder_Header
Method Summary
Description | Constants Methods (details)
void __construct (string $title, string $link, [string $charset = 'utf-8'])
Zend_Feed_Builder_Header setAuthor (string $author)
Zend_Feed_Builder_Header setCloud (string|Zend_Uri_Http $uri, string $procedure, string $protocol)
Zend_Feed_Builder_Header setCopyright (string $copyright)
Zend_Feed_Builder_Header setDescription (string $description)
Zend_Feed_Builder_Header setEmail (string $email)
Zend_Feed_Builder_Header setGenerator (string $generator)
Zend_Feed_Builder_Header setImage (string $image)
Zend_Feed_Builder_Header setITunes (Zend_Feed_Builder_Header_Itunes $itunes)
Zend_Feed_Builder_Header setLanguage (string $language)
Zend_Feed_Builder_Header setLastUpdate (int $lastUpdate)
Zend_Feed_Builder_Header setPublishedDate (int $published)
Zend_Feed_Builder_Header setRating (string $rating)
Zend_Feed_Builder_Header setSkipDays ( $days)
Zend_Feed_Builder_Header setSkipHours ( $hours)
Zend_Feed_Builder_Header setTextInput (string $title, string $description, string $name, string $link)
Zend_Feed_Builder_Header setTtl (int $ttl)
Zend_Feed_Builder_Header setWebmaster (string $webmaster)
mixed __get (string $name)
boolean __isset (string $key)
void __set (string $name, mixed $value)
void __unset (string $key)
Methods
Description | Constants Methods (details)
Constructor __construct (line 55)

Constructor

  • access: public
void __construct (string $title, string $link, [string $charset = 'utf-8'])
  • string $title: title of the feed
  • string $link: canonical url of the feed
  • string $charset: charset of the textual data
Redefinition of:
ArrayObject::constructor __construct ( $array )
setAuthor (line 157)

Sets the author of the feed

  • access: public
Zend_Feed_Builder_Header setAuthor (string $author)
  • string $author
setCloud (line 311)

Cloud to be notified of updates of the feed Ignored if atom is used

  • throws: Zend_Feed_Builder_Exception
  • access: public
Zend_Feed_Builder_Header setCloud (string|Zend_Uri_Http $uri, string $procedure, string $protocol)
  • string|Zend_Uri_Http $uri
  • string $procedure: procedure to call, e.g. myCloud.rssPleaseNotify
  • string $protocol: protocol to use, e.g. soap or xml-rpc
setCopyright (line 194)

Sets the copyright notice

  • access: public
Zend_Feed_Builder_Header setCopyright (string $copyright)
  • string $copyright
setDescription (line 145)

Short description of the feed

  • access: public
Zend_Feed_Builder_Header setDescription (string $description)
  • string $description
setEmail (line 170)

Sets the author's email

  • throws: Zend_Feed_Builder_Exception
  • access: public
Zend_Feed_Builder_Header setEmail (string $email)
  • string $email
setGenerator (line 218)

Sets the generator of the feed

  • access: public
Zend_Feed_Builder_Header setGenerator (string $generator)
  • string $generator
setImage (line 206)

Sets the image of the feed

  • access: public
Zend_Feed_Builder_Header setImage (string $image)
  • string $image
setITunes (line 418)

Sets the iTunes rss extension

  • access: public
Zend_Feed_Builder_Header setITunes (Zend_Feed_Builder_Header_Itunes $itunes)
setLanguage (line 230)

Sets the language of the feed

  • access: public
Zend_Feed_Builder_Header setLanguage (string $language)
  • string $language
setLastUpdate (line 121)

Timestamp of the update date

  • access: public
Zend_Feed_Builder_Header setLastUpdate (int $lastUpdate)
  • int $lastUpdate
setPublishedDate (line 133)

Timestamp of the publication date

  • access: public
Zend_Feed_Builder_Header setPublishedDate (int $published)
  • int $published
setRating (line 295)

PICS rating for the feed Ignored if atom is used

  • access: public
Zend_Feed_Builder_Header setRating (string $rating)
  • string $rating
setSkipDays (line 389)

Hint telling aggregators which days they can skip Ignored if atom is used

  • throws: Zend_Feed_Builder_Exception
  • access: public
Zend_Feed_Builder_Header setSkipDays ( $days)
  • array $days: list of days to skip, e.g. Monday
setSkipHours (line 359)

Hint telling aggregators which hours they can skip Ignored if atom is used

  • throws: Zend_Feed_Builder_Exception
  • access: public
Zend_Feed_Builder_Header setSkipHours ( $hours)
  • array $hours: list of hours in 24 format
setTextInput (line 342)

A text input box that can be displayed with the feed Ignored if atom is used

  • access: public
Zend_Feed_Builder_Header setTextInput (string $title, string $description, string $name, string $link)
  • string $title: the label of the Submit button in the text input area
  • string $description: explains the text input area
  • string $name: the name of the text object in the text input area
  • string $link: the URL of the CGI script that processes text input requests
setTtl (line 270)

How long in minutes a feed can be cached before refreshing Ignored if atom is used

  • throws: Zend_Feed_Builder_Exception
  • access: public
Zend_Feed_Builder_Header setTtl (int $ttl)
  • int $ttl
setWebmaster (line 244)

Email address for person responsible for technical issues Ignored if atom is used

  • throws: Zend_Feed_Builder_Exception
  • access: public
Zend_Feed_Builder_Header setWebmaster (string $webmaster)
  • string $webmaster
__get (line 70)

Read only properties accessor

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

Isset accessor

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

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

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
Description | Constants (details) | Methods (details)

Inherited Constants

Inherited from ArrayObject (Internal Class)

ARRAY_AS_PROPS = 2
 STD_PROP_LIST = 1

Documentation generated on Mon, 21 Jun 2010 15:26:08 -0400 by phpDocumentor 1.4.3