Feed/Builder/Header/Itunes.php

Show: PublicProtectedPrivateinherited
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Feed  
Version
$Id$  

\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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Methods

methodpublic__construct(array $categories) : void

Constructor

Parameters
NameTypeDescription
$categoriesarray

Categories columns and in iTunes Music Store Browse

methodpublic__get(string $name) : mixed

Read only properties accessor

Parameters
NameTypeDescription
$namestring

property to read

Returns
TypeDescription
mixed
methodpublic__isset(string $key) : boolean

Isset accessor

Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
boolean
methodpublic__set(string $name, mixed $value) : void

Write properties accessor

Parameters
NameTypeDescription
$namestring

name of the property to set

$valuemixed

value to set

methodpublic__unset(string $key) : void

Unset accessor

Parameters
NameTypeDescription
$keystring
methodpublicsetAuthor(string $author) : \Zend_Feed_Builder_Header_Itunes

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

Parameters
NameTypeDescription
$authorstring
Returns
TypeDescription
\Zend_Feed_Builder_Header_Itunes
methodpublicsetBlock(string $block) : \Zend_Feed_Builder_Header_Itunes

Prevent a feed from appearing

Parameters
NameTypeDescription
$blockstring

can be 'yes' or 'no'

Returns
TypeDescription
\Zend_Feed_Builder_Header_Itunes
Throws
ExceptionDescription
\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
NameTypeDescription
$categoriesarray
Returns
TypeDescription
\Zend_Feed_Builder_Header_Itunes
Throws
ExceptionDescription
\Zend_Feed_Builder_Exception
methodpublicsetExplicit(string $explicit) : \Zend_Feed_Builder_Header_Itunes

Configuration of the parental advisory graphic

Parameters
NameTypeDescription
$explicitstring

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

Returns
TypeDescription
\Zend_Feed_Builder_Header_Itunes
Throws
ExceptionDescription
\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
NameTypeDescription
$imagestring
Returns
TypeDescription
\Zend_Feed_Builder_Header_Itunes
methodpublicsetKeywords(string $keywords) : \Zend_Feed_Builder_Header_Itunes

Sets a comma separated list of 12 keywords maximum

Parameters
NameTypeDescription
$keywordsstring
Returns
TypeDescription
\Zend_Feed_Builder_Header_Itunes
methodpublicsetNewFeedUrl(string $url) : \Zend_Feed_Builder_Header_Itunes

Sets the new feed URL location

Parameters
NameTypeDescription
$urlstring
Returns
TypeDescription
\Zend_Feed_Builder_Header_Itunes
methodpublicsetOwner(string $name = '', string $email = '') : \Zend_Feed_Builder_Header_Itunes

Sets the owner of the postcast

Parameters
NameTypeDescription
$namestring

default to the feed's author value

$emailstring

default to the feed's email value

Returns
TypeDescription
\Zend_Feed_Builder_Header_Itunes
Throws
ExceptionDescription
\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
NameTypeDescription
$subtitlestring
Returns
TypeDescription
\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
NameTypeDescription
$summarystring
Returns
TypeDescription
\Zend_Feed_Builder_Header_Itunes
Documentation was generated by phpDocumentor 2.2.0 .