Feed/Builder/Header/Itunes.php
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 24593 2012-01-05 20:35:02Z matthew $
\Zend_Feed_Builder_Header_Itunes
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


__construct(array $categories) : void
Constructor
Name | Type | Description |
---|---|---|
$categories | array | Categories columns and in iTunes Music Store Browse |


__get(string $name) : mixed
Read only properties accessor
Name | Type | Description |
---|---|---|
$name | string | property to read |
Type | Description |
---|---|
mixed |


__isset(string $key) : boolean
Isset accessor
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
boolean |


__set(string $name, mixed $value) : void
Write properties accessor
Name | Type | Description |
---|---|---|
$name | string | name of the property to set |
$value | mixed | value to set |


setAuthor(string $author) : \Zend_Feed_Builder_Header_Itunes
Sets the artist value, default to the feed's author value
Name | Type | Description |
---|---|---|
$author | string |
Type | Description |
---|---|
\Zend_Feed_Builder_Header_Itunes |


setBlock(string $block) : \Zend_Feed_Builder_Header_Itunes
Prevent a feed from appearing
Name | Type | Description |
---|---|---|
$block | string | can be 'yes' or 'no' |
Type | Description |
---|---|
\Zend_Feed_Builder_Header_Itunes |
Exception | Description |
---|---|
\Zend_Feed_Builder_Exception |


setCategories(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
)
Name | Type | Description |
---|---|---|
$categories | array |
Type | Description |
---|---|
\Zend_Feed_Builder_Header_Itunes |
Exception | Description |
---|---|
\Zend_Feed_Builder_Exception |


setExplicit(string $explicit) : \Zend_Feed_Builder_Header_Itunes
Configuration of the parental advisory graphic
Name | Type | Description |
---|---|---|
$explicit | string | can be 'yes', 'no' or 'clean' |
Type | Description |
---|---|
\Zend_Feed_Builder_Header_Itunes |
Exception | Description |
---|---|
\Zend_Feed_Builder_Exception |


setImage(string $image) : \Zend_Feed_Builder_Header_Itunes
Sets the album/podcast art picture Default to the feed's image value
Name | Type | Description |
---|---|---|
$image | string |
Type | Description |
---|---|
\Zend_Feed_Builder_Header_Itunes |


setKeywords(string $keywords) : \Zend_Feed_Builder_Header_Itunes
Sets a comma separated list of 12 keywords maximum
Name | Type | Description |
---|---|---|
$keywords | string |
Type | Description |
---|---|
\Zend_Feed_Builder_Header_Itunes |


setNewFeedUrl(string $url) : \Zend_Feed_Builder_Header_Itunes
Sets the new feed URL location
Name | Type | Description |
---|---|---|
$url | string |
Type | Description |
---|---|
\Zend_Feed_Builder_Header_Itunes |


setOwner(string $name = '', string $email = '') : \Zend_Feed_Builder_Header_Itunes
Sets the owner of the postcast
Name | Type | Description |
---|---|---|
$name | string | default to the feed's author value |
string | default to the feed's email value |
Type | Description |
---|---|
\Zend_Feed_Builder_Header_Itunes |
Exception | Description |
---|---|
\Zend_Feed_Builder_Exception |


setSubtitle(string $subtitle) : \Zend_Feed_Builder_Header_Itunes
Sets the short description of the podcast Default to the feed's description
Name | Type | Description |
---|---|---|
$subtitle | string |
Type | Description |
---|---|
\Zend_Feed_Builder_Header_Itunes |


setSummary(string $summary) : \Zend_Feed_Builder_Header_Itunes
Sets the longer description of the podcast Default to the feed's description
Name | Type | Description |
---|---|---|
$summary | string |
Type | Description |
---|---|
\Zend_Feed_Builder_Header_Itunes |