API Documentation

Zend/Feed/Builder/Header/Itunes.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: Itunes.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Feed_Builder_Header_Itunes

Package: Zend\Feed

ITunes rss extension

Classes used to describe the itunes channel extension

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( array $categories ) : void

Constructor

Parameters
Name Type Description
$categories array

Categories columns and in iTunes Music Store Browse

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_Itunes

Sets the artist value, default to the feed's author value

Parameters
Name Type Description
$author string
Returns
Type Description
\Zend_Feed_Builder_Header_Itunes
methodpublicsetBlock( string $block ) : \Zend_Feed_Builder_Header_Itunes

Prevent a feed from appearing

Parameters
Name Type Description
$block string

can be 'yes' or 'no'

Returns
Type Description
\Zend_Feed_Builder_Header_Itunes
Throws
Exception Description
\Zend_Feed_Builder_Exception
methodpublicsetCategories( array $categories ) : \Zend_Feed_Builder_Header_Itunes

Sets the categories column and in iTunes Music Store Browse $categories must conform to the following format: array(array('main' => 'main category', 'sub' => 'sub category' // optionnal ), // up to 3 rows )

Parameters
Name Type Description
$categories array
Returns
Type Description
\Zend_Feed_Builder_Header_Itunes
Throws
Exception Description
\Zend_Feed_Builder_Exception
methodpublicsetExplicit( string $explicit ) : \Zend_Feed_Builder_Header_Itunes

Configuration of the parental advisory graphic

Parameters
Name Type Description
$explicit string

can be 'yes', 'no' or 'clean'

Returns
Type Description
\Zend_Feed_Builder_Header_Itunes
Throws
Exception Description
\Zend_Feed_Builder_Exception
methodpublicsetImage( string $image ) : \Zend_Feed_Builder_Header_Itunes

Sets the album/podcast art picture Default to the feed's image value

Parameters
Name Type Description
$image string
Returns
Type Description
\Zend_Feed_Builder_Header_Itunes
methodpublicsetKeywords( string $keywords ) : \Zend_Feed_Builder_Header_Itunes

Sets a comma separated list of 12 keywords maximum

Parameters
Name Type Description
$keywords string
Returns
Type Description
\Zend_Feed_Builder_Header_Itunes
methodpublicsetNewFeedUrl( string $url ) : \Zend_Feed_Builder_Header_Itunes

Sets the new feed URL location

Parameters
Name Type Description
$url string
Returns
Type Description
\Zend_Feed_Builder_Header_Itunes
methodpublicsetOwner( string $name = '', string $email = '' ) : \Zend_Feed_Builder_Header_Itunes

Sets the owner of the postcast

Parameters
Name Type Description
$name string

default to the feed's author value

$email string

default to the feed's email value

Returns
Type Description
\Zend_Feed_Builder_Header_Itunes
Throws
Exception Description
\Zend_Feed_Builder_Exception
methodpublicsetSubtitle( string $subtitle ) : \Zend_Feed_Builder_Header_Itunes

Sets the short description of the podcast Default to the feed's description

Parameters
Name Type Description
$subtitle string
Returns
Type Description
\Zend_Feed_Builder_Header_Itunes
methodpublicsetSummary( string $summary ) : \Zend_Feed_Builder_Header_Itunes

Sets the longer description of the podcast Default to the feed's description

Parameters
Name Type Description
$summary string
Returns
Type Description
\Zend_Feed_Builder_Header_Itunes
Documentation was generated by DocBlox 0.15.1.