API Documentation

Zend/Feed/Builder/Header.php

Show: inherited
Table of Contents

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.

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 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Feed_Builder_Header

Package: Zend\Feed

Header 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

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

Constructor

Parameters
Name Type Description
$title string

title of the feed

$link string

canonical url of the feed

$charset string

charset of the textual data

methodpublic__get( string $name ) : mixed

Read only properties accessor

Parameters
Name Type Description
$name string

property to read

Returns
Type Description
mixed
methodpublic__isset( string $key ) : boolean

Isset accessor

Parameters
Name Type Description
$key string
Returns
Type Description
boolean
methodpublic__set( string $name, mixed $value ) : void

Write properties accessor

Parameters
Name Type Description
$name string

name of the property to set

$value mixed

value to set

methodpublic__unset( string $key ) : void

Unset accessor

Parameters
Name Type Description
$key string
methodpublicsetAuthor( string $author ) : \Zend_Feed_Builder_Header

Sets the author of the feed

Parameters
Name Type Description
$author string
Returns
Type Description
\Zend_Feed_Builder_Header
methodpublicsetCloud( 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

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
Type Description
\Zend_Feed_Builder_Header
Throws
Exception Description
\Zend_Feed_Builder_Exception
methodpublicsetCopyright( string $copyright ) : \Zend_Feed_Builder_Header

Sets the copyright notice

Parameters
Name Type Description
$copyright string
Returns
Type Description
\Zend_Feed_Builder_Header
methodpublicsetDescription( string $description ) : \Zend_Feed_Builder_Header

Short description of the feed

Parameters
Name Type Description
$description string
Returns
Type Description
\Zend_Feed_Builder_Header
methodpublicsetEmail( string $email ) : \Zend_Feed_Builder_Header

Sets the author's email

Parameters
Name Type Description
$email string
Returns
Type Description
\Zend_Feed_Builder_Header
Throws
Exception Description
\Zend_Feed_Builder_Exception
methodpublicsetGenerator( string $generator ) : \Zend_Feed_Builder_Header

Sets the generator of the feed

Parameters
Name Type Description
$generator string
Returns
Type Description
\Zend_Feed_Builder_Header
methodpublicsetITunes( \Zend_Feed_Builder_Header_Itunes $itunes ) : \Zend_Feed_Builder_Header

Sets the iTunes rss extension

Parameters
Name Type Description
$itunes \Zend_Feed_Builder_Header_Itunes
Returns
Type Description
\Zend_Feed_Builder_Header
methodpublicsetImage( string $image ) : \Zend_Feed_Builder_Header

Sets the image of the feed

Parameters
Name Type Description
$image string
Returns
Type Description
\Zend_Feed_Builder_Header
methodpublicsetLanguage( string $language ) : \Zend_Feed_Builder_Header

Sets the language of the feed

Parameters
Name Type Description
$language string
Returns
Type Description
\Zend_Feed_Builder_Header
methodpublicsetLastUpdate( int $lastUpdate ) : \Zend_Feed_Builder_Header

Timestamp of the update date

Parameters
Name Type Description
$lastUpdate int
Returns
Type Description
\Zend_Feed_Builder_Header
methodpublicsetPublishedDate( int $published ) : \Zend_Feed_Builder_Header

Timestamp of the publication date

Parameters
Name Type Description
$published int
Returns
Type Description
\Zend_Feed_Builder_Header
methodpublicsetRating( string $rating ) : \Zend_Feed_Builder_Header

PICS rating for the feed Ignored if atom is used

Parameters
Name Type Description
$rating string
Returns
Type Description
\Zend_Feed_Builder_Header
methodpublicsetSkipDays( array $days ) : \Zend_Feed_Builder_Header

Hint 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
Type Description
\Zend_Feed_Builder_Header
Throws
Exception Description
\Zend_Feed_Builder_Exception
methodpublicsetSkipHours( array $hours ) : \Zend_Feed_Builder_Header

Hint 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
Type Description
\Zend_Feed_Builder_Header
Throws
Exception Description
\Zend_Feed_Builder_Exception
methodpublicsetTextInput( 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

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
Type Description
\Zend_Feed_Builder_Header
methodpublicsetTtl( int $ttl ) : \Zend_Feed_Builder_Header

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

Parameters
Name Type Description
$ttl int
Returns
Type Description
\Zend_Feed_Builder_Header
Throws
Exception Description
\Zend_Feed_Builder_Exception
methodpublicsetWebmaster( string $webmaster ) : \Zend_Feed_Builder_Header

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

Parameters
Name Type Description
$webmaster string
Returns
Type Description
\Zend_Feed_Builder_Header
Throws
Exception Description
\Zend_Feed_Builder_Exception
Documentation was generated by DocBlox 0.15.1.