Feed/Builder/Header.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Feed
version: $Id: Header.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Feed_Builder_Header

Description

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.

Zend_Feed_Builder_Header
jump to top

Extends from: ArrayObject
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Feed
Methods: __construct; __get; __set; __isset; __unset; setLastUpdate; setPublishedDate; setDescription; setAuthor; setEmail; setCopyright; setImage; setGenerator; setLanguage; setWebmaster; setTtl; setRating; setCloud; setTextInput; setSkipHours; setSkipDays; setITunes

Description

Header of a custom build feed

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

Methods

__construct
jump to class

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

Constructor

Arguments

$title: string
title of the feed
$link: string
canonical url of the feed
$charset: string
charset of the textual data

Details

visibility: public
final: false
static: false

__get
jump to class

__get(
          string $name
          )
        
        :
        mixed

Read only properties accessor

Arguments

$name: string
property to read

Output

mixed

Details

visibility: public
final: false
static: false

__isset
jump to class

__isset(
          string $key
          )
        
        :
        boolean

Isset accessor

Arguments

$key: string

Output

boolean

Details

visibility: public
final: false
static: false

__set
jump to class

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

Write properties accessor

Arguments

$name: string
name of the property to set
$value: mixed
value to set

Details

visibility: public
final: false
static: false

__unset
jump to class

__unset(
          string $key
          )
        
        :
        void

Unset accessor

Arguments

$key: string

Details

visibility: public
final: false
static: false

setAuthor
jump to class

setAuthor(
          string $author
          )
        
        :
        Zend_Feed_Builder_Header

Sets the author of the feed

Arguments

$author: string

Output

Zend_Feed_Builder_Header

Details

visibility: public
final: false
static: false

setCloud
jump to class

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

Arguments

$uri: stringZend_Uri_Http
$procedure: string
procedure to call, e.g. myCloud.rssPleaseNotify
$protocol: string
protocol to use, e.g. soap or xml-rpc

Output

Zend_Feed_Builder_Header

Details

visibility: public
final: false
static: false
throws

setCopyright
jump to class

setCopyright(
          string $copyright
          )
        
        :
        Zend_Feed_Builder_Header

Sets the copyright notice

Arguments

$copyright: string

Output

Zend_Feed_Builder_Header

Details

visibility: public
final: false
static: false

setDescription
jump to class

setDescription(
          string $description
          )
        
        :
        Zend_Feed_Builder_Header

Short description of the feed

Arguments

$description: string

Output

Zend_Feed_Builder_Header

Details

visibility: public
final: false
static: false

setEmail
jump to class

setEmail(
          string $email
          )
        
        :
        Zend_Feed_Builder_Header

Sets the author's email

Arguments

$email: string

Output

Zend_Feed_Builder_Header

Details

visibility: public
final: false
static: false
throws

setGenerator
jump to class

setGenerator(
          string $generator
          )
        
        :
        Zend_Feed_Builder_Header

Sets the generator of the feed

Arguments

$generator: string

Output

Zend_Feed_Builder_Header

Details

visibility: public
final: false
static: false

setITunes
jump to class

setITunes(
          Zend_Feed_Builder_Header_Itunes $itunes
          )
        
        :
        Zend_Feed_Builder_Header

Sets the iTunes rss extension

Arguments

$itunes: Zend_Feed_Builder_Header_Itunes

Output

Zend_Feed_Builder_Header

Details

visibility: public
final: false
static: false

setImage
jump to class

setImage(
          string $image
          )
        
        :
        Zend_Feed_Builder_Header

Sets the image of the feed

Arguments

$image: string

Output

Zend_Feed_Builder_Header

Details

visibility: public
final: false
static: false

setLanguage
jump to class

setLanguage(
          string $language
          )
        
        :
        Zend_Feed_Builder_Header

Sets the language of the feed

Arguments

$language: string

Output

Zend_Feed_Builder_Header

Details

visibility: public
final: false
static: false

setLastUpdate
jump to class

setLastUpdate(
          int $lastUpdate
          )
        
        :
        Zend_Feed_Builder_Header

Timestamp of the update date

Arguments

$lastUpdate: int

Output

Zend_Feed_Builder_Header

Details

visibility: public
final: false
static: false

setPublishedDate
jump to class

setPublishedDate(
          int $published
          )
        
        :
        Zend_Feed_Builder_Header

Timestamp of the publication date

Arguments

$published: int

Output

Zend_Feed_Builder_Header

Details

visibility: public
final: false
static: false

setRating
jump to class

setRating(
          string $rating
          )
        
        :
        Zend_Feed_Builder_Header

PICS rating for the feed Ignored if atom is used

Arguments

$rating: string

Output

Zend_Feed_Builder_Header

Details

visibility: public
final: false
static: false

setSkipDays
jump to class

setSkipDays(
          array $days
          )
        
        :
        Zend_Feed_Builder_Header

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

Arguments

$days: array
list of days to skip, e.g. Monday

Output

Zend_Feed_Builder_Header

Details

visibility: public
final: false
static: false
throws

setSkipHours
jump to class

setSkipHours(
          array $hours
          )
        
        :
        Zend_Feed_Builder_Header

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

Arguments

$hours: array
list of hours in 24 format

Output

Zend_Feed_Builder_Header

Details

visibility: public
final: false
static: false
throws

setTextInput
jump to class

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

Arguments

$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

Output

Zend_Feed_Builder_Header

Details

visibility: public
final: false
static: false

setTtl
jump to class

setTtl(
          int $ttl
          )
        
        :
        Zend_Feed_Builder_Header

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

Arguments

$ttl: int

Output

Zend_Feed_Builder_Header

Details

visibility: public
final: false
static: false
throws

setWebmaster
jump to class

setWebmaster(
          string $webmaster
          )
        
        :
        Zend_Feed_Builder_Header

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

Arguments

$webmaster: string

Output

Zend_Feed_Builder_Header

Details

visibility: public
final: false
static: false
throws

API Documentation

Feed/Builder/Header.php

Description

Zend_Feed_Builder_Headerjump to top

Description

Methods

__constructjump to class

Arguments

Details

__getjump to class

Arguments

Output

Details

__issetjump to class

Arguments

Output

Details

__setjump to class

Arguments

Details

__unsetjump to class

Arguments

Details

setAuthorjump to class

Arguments

Output

Details

setCloudjump to class

Arguments

Output

Details

setCopyrightjump to class

Arguments

Output

Details

setDescriptionjump to class

Arguments

Output

Details

setEmailjump to class

Arguments

Output

Details

setGeneratorjump to class

Arguments

Output

Details

setITunesjump to class

Arguments

Output

Details

setImagejump to class

Arguments

Output

Details

setLanguagejump to class

Arguments

Output

Details

setLastUpdatejump to class

Arguments

Output

Details

setPublishedDatejump to class

Arguments

Output

Details

setRatingjump to class

Arguments

Output

Details

setSkipDaysjump to class

Arguments

Output

Details

setSkipHoursjump to class

Arguments

Output

Details

setTextInputjump to class

Zend_Feed_Builder_Header
jump to top

__construct
jump to class

__get
jump to class

__isset
jump to class

__set
jump to class

__unset
jump to class

setAuthor
jump to class

setCloud
jump to class

setCopyright
jump to class

setDescription
jump to class

setEmail
jump to class

setGenerator
jump to class

setITunes
jump to class

setImage
jump to class

setLanguage
jump to class

setLastUpdate
jump to class

setPublishedDate
jump to class

setRating
jump to class

setSkipDays
jump to class

setSkipHours
jump to class

setTextInput
jump to class

setTtl
jump to class

setWebmaster
jump to class