Header of a custom build feed

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

category Zend
package Zend_Feed
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Constructor

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

Parameters

$title

string

title of the feed

$link

string

canonical url of the feed

$charset

string

charset of the textual data

Read only properties accessor

__get(string $name) : mixed

Parameters

$name

string

property to read

Returns

mixed

Isset accessor

__isset(string $key) : boolean

Parameters

$key

string

Returns

boolean

Write properties accessor

__set(string $name, mixed $value) : void

Parameters

$name

string

name of the property to set

$value

mixed

value to set

Unset accessor

__unset(string $key) : void

Parameters

$key

string

Sets the author of the feed

setAuthor(string $author) : \Zend_Feed_Builder_Header

Parameters

$author

string

Returns

\Zend_Feed_Builder_Header

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

setCloud(string|\Zend_Uri_Http $uri, string $procedure, string $protocol) : \Zend_Feed_Builder_Header

Parameters

$uri

string\Zend_Uri_Http

$procedure

string

procedure to call, e.g. myCloud.rssPleaseNotify

$protocol

string

protocol to use, e.g. soap or xml-rpc

Exceptions

\Zend_Feed_Builder_Exception

Returns

\Zend_Feed_Builder_Header

Sets the copyright notice

setCopyright(string $copyright) : \Zend_Feed_Builder_Header

Parameters

$copyright

string

Returns

\Zend_Feed_Builder_Header

Short description of the feed

setDescription(string $description) : \Zend_Feed_Builder_Header

Parameters

$description

string

Returns

\Zend_Feed_Builder_Header

Sets the author's email

setEmail(string $email) : \Zend_Feed_Builder_Header

Parameters

$email

string

Exceptions

\Zend_Feed_Builder_Exception

Returns

\Zend_Feed_Builder_Header

Sets the generator of the feed

setGenerator(string $generator) : \Zend_Feed_Builder_Header

Parameters

$generator

string

Returns

\Zend_Feed_Builder_Header

Sets the iTunes rss extension

setITunes(\Zend_Feed_Builder_Header_Itunes $itunes) : \Zend_Feed_Builder_Header

Parameters

$itunes

\Zend_Feed_Builder_Header_Itunes

Returns

\Zend_Feed_Builder_Header

Sets the image of the feed

setImage(string $image) : \Zend_Feed_Builder_Header

Parameters

$image

string

Returns

\Zend_Feed_Builder_Header

Sets the language of the feed

setLanguage(string $language) : \Zend_Feed_Builder_Header

Parameters

$language

string

Returns

\Zend_Feed_Builder_Header

Timestamp of the update date

setLastUpdate(integer $lastUpdate) : \Zend_Feed_Builder_Header

Parameters

$lastUpdate

integer

Returns

\Zend_Feed_Builder_Header

Timestamp of the publication date

setPublishedDate(integer $published) : \Zend_Feed_Builder_Header

Parameters

$published

integer

Returns

\Zend_Feed_Builder_Header

PICS rating for the feed Ignored if atom is used

setRating(string $rating) : \Zend_Feed_Builder_Header

Parameters

$rating

string

Returns

\Zend_Feed_Builder_Header

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

setSkipDays(array $days) : \Zend_Feed_Builder_Header

Parameters

$days

array

list of days to skip, e.g. Monday

Exceptions

\Zend_Feed_Builder_Exception

Returns

\Zend_Feed_Builder_Header

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

setSkipHours(array $hours) : \Zend_Feed_Builder_Header

Parameters

$hours

array

list of hours in 24 format

Exceptions

\Zend_Feed_Builder_Exception

Returns

\Zend_Feed_Builder_Header

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

setTextInput(string $title, string $description, string $name, string $link) : \Zend_Feed_Builder_Header

Parameters

$title

string

the label of the Submit button in the text input area

$description

string

explains the text input area

$name

string

the name of the text object in the text input area

$link

string

the URL of the CGI script that processes text input requests

Returns

\Zend_Feed_Builder_Header

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

setTtl(integer $ttl) : \Zend_Feed_Builder_Header

Parameters

$ttl

integer

Exceptions

\Zend_Feed_Builder_Exception

Returns

\Zend_Feed_Builder_Header

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

setWebmaster(string $webmaster) : \Zend_Feed_Builder_Header

Parameters

$webmaster

string

Exceptions

\Zend_Feed_Builder_Exception

Returns

\Zend_Feed_Builder_Header