Feed/Builder/Header.php
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 [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
-
New BSD License
- Package
- Zend_Feed
- Version
- $Id: Header.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Feed_Builder_Header
Package: Zend\FeedHeader of a custom build feed
Classes implementing the Zend_Feed_Builder_Interface interface
uses this class to describe the header of a feed
- Parent(s)
- \ArrayObject
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
-
New BSD License
Methods
__construct(string $title, string $link, string $charset = 'utf-8') : void
Parameters
| 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) : mixedRead only properties accessor
Parameters
| Name |
Type |
Description |
| $name |
string |
property to read |
Returns
__set(string $name, mixed $value) : voidWrite properties accessor
Parameters
| Name |
Type |
Description |
| $name |
string |
name of the property to set |
| $value |
mixed |
value to set |
setAuthor(string $author) : \Zend_Feed_Builder_HeaderSets the author of the feed
Parameters
| Name |
Type |
Description |
| $author |
string |
|
Returns
setCloud(string | \Zend_Uri_Http $uri, string $procedure, string $protocol) : \Zend_Feed_Builder_HeaderCloud to be notified of updates of the feed
Ignored if atom is used
Parameters
| 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
|
Returns
Throws
setCopyright(string $copyright) : \Zend_Feed_Builder_HeaderSets the copyright notice
Parameters
| Name |
Type |
Description |
| $copyright |
string |
|
Returns
setDescription(string $description) : \Zend_Feed_Builder_HeaderShort description of the feed
Parameters
| Name |
Type |
Description |
| $description |
string |
|
Returns
setGenerator(string $generator) : \Zend_Feed_Builder_HeaderSets the generator of the feed
Parameters
| Name |
Type |
Description |
| $generator |
string |
|
Returns
setImage(string $image) : \Zend_Feed_Builder_HeaderSets the image of the feed
Parameters
| Name |
Type |
Description |
| $image |
string |
|
Returns
setLanguage(string $language) : \Zend_Feed_Builder_HeaderSets the language of the feed
Parameters
| Name |
Type |
Description |
| $language |
string |
|
Returns
setLastUpdate(int $lastUpdate) : \Zend_Feed_Builder_HeaderTimestamp of the update date
Parameters
| Name |
Type |
Description |
| $lastUpdate |
int |
|
Returns
setPublishedDate(int $published) : \Zend_Feed_Builder_HeaderTimestamp of the publication date
Parameters
| Name |
Type |
Description |
| $published |
int |
|
Returns
setRating(string $rating) : \Zend_Feed_Builder_HeaderPICS rating for the feed
Ignored if atom is used
Parameters
| Name |
Type |
Description |
| $rating |
string |
|
Returns
setSkipDays(array $days) : \Zend_Feed_Builder_HeaderHint telling aggregators which days they can skip
Ignored if atom is used
Parameters
| Name |
Type |
Description |
| $days |
array |
list of days to skip, e.g. Monday |
Returns
Throws
setSkipHours(array $hours) : \Zend_Feed_Builder_HeaderHint telling aggregators which hours they can skip
Ignored if atom is used
Parameters
| Name |
Type |
Description |
| $hours |
array |
list of hours in 24 format |
Returns
Throws
setTextInput(string $title, string $description, string $name, string $link) : \Zend_Feed_Builder_HeaderA text input box that can be displayed with the feed
Ignored if atom is used
Parameters
| 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 |
Returns
setTtl(int $ttl) : \Zend_Feed_Builder_HeaderHow long in minutes a feed can be cached before refreshing
Ignored if atom is used
Parameters
| Name |
Type |
Description |
| $ttl |
int |
|
Returns
Throws
setWebmaster(string $webmaster) : \Zend_Feed_Builder_HeaderEmail address for person responsible for technical issues
Ignored if atom is used
Parameters
| Name |
Type |
Description |
| $webmaster |
string |
|
Returns
Throws
inherited
Classes