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

Public Member Functions

 __construct ($title, $link, $charset= 'utf-8')
 Constructor.
 
 __get ($name)
 Read only properties accessor.
 
 __set ($name, $value)
 Write properties accessor.
 
 __isset ($key)
 Isset accessor.
 
 __unset ($key)
 Unset accessor.
 
 setLastUpdate ($lastUpdate)
 Timestamp of the update date.
 
 setPublishedDate ($published)
 Timestamp of the publication date.
 
 setDescription ($description)
 Short description of the feed.
 
 setAuthor ($author)
 Sets the author of the feed.
 
 setEmail ($email)
 Sets the author's email.
 
 setCopyright ($copyright)
 Sets the copyright notice.
 
 setImage ($image)
 Sets the image of the feed.
 
 setGenerator ($generator)
 Sets the generator of the feed.
 
 setLanguage ($language)
 Sets the language of the feed.
 
 setWebmaster ($webmaster)
 Email address for person responsible for technical issues Ignored if atom is used.
 
 setTtl ($ttl)
 How long in minutes a feed can be cached before refreshing Ignored if atom is used.
 
 setRating ($rating)
 PICS rating for the feed Ignored if atom is used.
 
 setCloud ($uri, $procedure, $protocol)
 Cloud to be notified of updates of the feed Ignored if atom is used.
 
 setTextInput ($title, $description, $name, $link)
 A text input box that can be displayed with the feed Ignored if atom is used.
 
 setSkipHours (array $hours)
 Hint telling aggregators which hours they can skip Ignored if atom is used.
 
 setSkipDays (array $days)
 Hint telling aggregators which days they can skip Ignored if atom is used.
 
 setITunes (Zend_Feed_Builder_Header_Itunes $itunes)
 Sets the iTunes rss extension.
 

Constructor & Destructor Documentation

__construct (   $title,
  $link,
  $charset = 'utf-8' 
)

Constructor.

Parameters
string$titletitle of the feed
string$linkcanonical url of the feed
string$charsetcharset of the textual data
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
setAuthor (   $author)

Sets the author of the feed.

Parameters
string$author
Returns
Zend_Feed_Builder_Header
setCloud (   $uri,
  $procedure,
  $protocol 
)

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

Parameters
string | Zend_Uri_Http$uri
string$procedureprocedure to call, e.g. myCloud.rssPleaseNotify
string$protocolprotocol to use, e.g. soap or xml-rpc
Returns
Zend_Feed_Builder_Header
Exceptions
Zend_Feed_Builder_Exception
See Also
Zend_Feed_Builder_Exception
setCopyright (   $copyright)

Sets the copyright notice.

Parameters
string$copyright
Returns
Zend_Feed_Builder_Header
setDescription (   $description)

Short description of the feed.

Parameters
string$description
Returns
Zend_Feed_Builder_Header
setEmail (   $email)

Sets the author's email.

Parameters
string$email
Returns
Zend_Feed_Builder_Header
Exceptions
Zend_Feed_Builder_Exception
See Also
Zend_Validate_EmailAddress
Zend_Feed_Builder_Exception
setGenerator (   $generator)

Sets the generator of the feed.

Parameters
string$generator
Returns
Zend_Feed_Builder_Header
setImage (   $image)

Sets the image of the feed.

Parameters
string$image
Returns
Zend_Feed_Builder_Header
setITunes ( Zend_Feed_Builder_Header_Itunes  $itunes)

Sets the iTunes rss extension.

Parameters
Zend_Feed_Builder_Header_Itunes$itunes
Returns
Zend_Feed_Builder_Header
setLanguage (   $language)

Sets the language of the feed.

Parameters
string$language
Returns
Zend_Feed_Builder_Header
setLastUpdate (   $lastUpdate)

Timestamp of the update date.

Parameters
int$lastUpdate
Returns
Zend_Feed_Builder_Header
setPublishedDate (   $published)

Timestamp of the publication date.

Parameters
int$published
Returns
Zend_Feed_Builder_Header
setRating (   $rating)

PICS rating for the feed Ignored if atom is used.

Parameters
string$rating
Returns
Zend_Feed_Builder_Header
setSkipDays ( array  $days)

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

Parameters
array$dayslist of days to skip, e.g. Monday
Returns
Zend_Feed_Builder_Header
Exceptions
Zend_Feed_Builder_Exception
See Also
Zend_Feed_Builder_Exception
Zend_Feed_Builder_Exception
setSkipHours ( array  $hours)

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

Parameters
array$hourslist of hours in 24 format
Returns
Zend_Feed_Builder_Header
Exceptions
Zend_Feed_Builder_Exception
See Also
Zend_Feed_Builder_Exception
Zend_Feed_Builder_Exception
setTextInput (   $title,
  $description,
  $name,
  $link 
)

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

Parameters
string$titlethe label of the Submit button in the text input area
string$descriptionexplains the text input area
string$namethe name of the text object in the text input area
string$linkthe URL of the CGI script that processes text input requests
Returns
Zend_Feed_Builder_Header
setTtl (   $ttl)

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

Parameters
int$ttl
Returns
Zend_Feed_Builder_Header
Exceptions
Zend_Feed_Builder_Exception
See Also
Zend_Validate_Int
Zend_Feed_Builder_Exception
setWebmaster (   $webmaster)

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

Parameters
string$webmaster
Returns
Zend_Feed_Builder_Header
Exceptions
Zend_Feed_Builder_Exception
See Also
Zend_Validate_EmailAddress
Zend_Feed_Builder_Exception