Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Header of a custom build feed
Classes implementing the Zend_Feed_Builder_Interface interface uses this class to describe the header of a feed

__construct(
string $title, string $link, string $charset
=
'utf-8'
)
:
void
Constructor
Name | Type | Description |
---|---|---|
$title | string | title of the feed |
$link | string | canonical url of the feed |
$charset | string | charset of the textual data |

__get(
string $name
)
:
mixed
Read only properties accessor
Name | Type | Description |
---|---|---|
$name | string | property to read |
Type | Description |
---|---|
mixed |

__isset(
string $key
)
:
boolean
Isset accessor
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
boolean |

__set(
string $name, mixed $value
)
:
void
Write properties accessor
Name | Type | Description |
---|---|---|
$name | string | name of the property to set |
$value | mixed | value to set |

setCloud(
string|\Zend_Uri_Http $uri, string $procedure, string $protocol
)
:
\Zend_Feed_Builder_Header
Cloud to be notified of updates of the feed Ignored if atom is used
Name | Type | Description |
---|---|---|
$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 |
Type | Description |
---|---|
\Zend_Feed_Builder_Header |
Exception | Description |
---|---|
\Zend_Feed_Builder_Exception |

setCopyright(
string $copyright
)
:
\Zend_Feed_Builder_Header
Sets the copyright notice
Name | Type | Description |
---|---|---|
$copyright | string |
Type | Description |
---|---|
\Zend_Feed_Builder_Header |

setDescription(
string $description
)
:
\Zend_Feed_Builder_Header
Short description of the feed
Name | Type | Description |
---|---|---|
$description | string |
Type | Description |
---|---|
\Zend_Feed_Builder_Header |

setEmail(
string $email
)
:
\Zend_Feed_Builder_Header
Sets the author's email
Name | Type | Description |
---|---|---|
string |
Type | Description |
---|---|
\Zend_Feed_Builder_Header |
Exception | Description |
---|---|
\Zend_Feed_Builder_Exception |

setGenerator(
string $generator
)
:
\Zend_Feed_Builder_Header
Sets the generator of the feed
Name | Type | Description |
---|---|---|
$generator | string |
Type | Description |
---|---|
\Zend_Feed_Builder_Header |

setITunes(
\Zend_Feed_Builder_Header_Itunes $itunes
)
:
\Zend_Feed_Builder_Header
Sets the iTunes rss extension
Name | Type | Description |
---|---|---|
$itunes | \Zend_Feed_Builder_Header_Itunes |
Type | Description |
---|---|
\Zend_Feed_Builder_Header |

setLanguage(
string $language
)
:
\Zend_Feed_Builder_Header
Sets the language of the feed
Name | Type | Description |
---|---|---|
$language | string |
Type | Description |
---|---|
\Zend_Feed_Builder_Header |

setRating(
string $rating
)
:
\Zend_Feed_Builder_Header
PICS rating for the feed Ignored if atom is used

setSkipDays(
array $days
)
:
\Zend_Feed_Builder_Header
Hint telling aggregators which days they can skip Ignored if atom is used
Name | Type | Description |
---|---|---|
$days | array | list of days to skip, e.g. Monday |
Type | Description |
---|---|
\Zend_Feed_Builder_Header |
Exception | Description |
---|---|
\Zend_Feed_Builder_Exception |

setSkipHours(
array $hours
)
:
\Zend_Feed_Builder_Header
Hint telling aggregators which hours they can skip Ignored if atom is used
Name | Type | Description |
---|---|---|
$hours | array | list of hours in 24 format |
Type | Description |
---|---|
\Zend_Feed_Builder_Header |
Exception | Description |
---|---|
\Zend_Feed_Builder_Exception |

setTextInput(
string $title, string $description, string $name, string $link
)
:
\Zend_Feed_Builder_Header
A text input box that can be displayed with the feed Ignored if atom is used
Name | Type | Description |
---|---|---|
$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 |
Type | Description |
---|---|
\Zend_Feed_Builder_Header |

setTtl(
int $ttl
)
:
\Zend_Feed_Builder_Header
How long in minutes a feed can be cached before refreshing Ignored if atom is used
Name | Type | Description |
---|---|---|
$ttl | int |
Type | Description |
---|---|
\Zend_Feed_Builder_Header |
Exception | Description |
---|---|
\Zend_Feed_Builder_Exception |

setWebmaster(
string $webmaster
)
:
\Zend_Feed_Builder_Header
Email address for person responsible for technical issues Ignored if atom is used
Name | Type | Description |
---|---|---|
$webmaster | string |
Type | Description |
---|---|
\Zend_Feed_Builder_Header |
Exception | Description |
---|---|
\Zend_Feed_Builder_Exception |