API Documentation

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

\Zend_Feed_Builder

Package: Zend\Feed

A simple implementation of Zend_Feed_Builder_Interface.

Users are encouraged to make their own classes to implement Zend_Feed_Builder_Interface

Implements
\Zend_Feed_Builder_Interface
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprivate\$_data  $_data= ''

The data of the feed

array
Details
Type
\$_data
Propertyprivate\$_entries  $_entries= 'array()'

List of the entries of the feed

array
Default valuearray()Details
Type
\$_entries
Propertyprivate\$_header  $_header= ''

Header of the feed

Zend_Feed_Builder_Header
Details
Type
\$_header

Methods

methodpublic__construct( array $data ) : void

Constructor. The $data array must conform to the following format: array( 'title' => 'title of the feed', //required 'link' => 'canonical url to the feed', //required 'lastUpdate' => 'timestamp of the update date', // optional 'published' => 'timestamp of the publication date', //optional 'charset' => 'charset', // required 'description' => 'short description of the feed', //optional 'author' => 'author/publisher of the feed', //optional 'email' => 'email of the author', //optional 'webmaster' => 'email address for person responsible for technical issues' // optional, ignored if atom is used 'copyright' => 'copyright notice', //optional 'image' => 'url to image', //optional 'generator' => 'generator', // optional 'language' => 'language the feed is written in', // optional 'ttl' => 'how long in minutes a feed can be cached before refreshing', // optional, ignored if atom is used 'rating' => 'The PICS rating for the channel.', // optional, ignored if atom is used 'cloud' => array( 'domain' => 'domain of the cloud, e.g. rpc.sys.com' // required 'port' => 'port to connect to' // optional, default to 80 'path' => 'path of the cloud, e.g. /RPC2 //required 'registerProcedure' => 'procedure to call, e.g. myCloud.rssPleaseNotify' // required 'protocol' => 'protocol to use, e.g. soap or xml-rpc' // required ), a cloud to be notified of updates // optional, ignored if atom is used 'textInput' => array( 'title' => 'the label of the Submit button in the text input area' // required, 'description' => 'explains the text input area' // required 'name' => 'the name of the text object in the text input area' // required 'link' => 'the URL of the CGI script that processes text input requests' // required ) // a text input box that can be displayed with the feed // optional, ignored if atom is used 'skipHours' => array( 'hour in 24 format', // e.g 13 (1pm) // up to 24 rows whose value is a number between 0 and 23 ) // Hint telling aggregators which hours they can skip // optional, ignored if atom is used 'skipDays ' => array( 'a day to skip', // e.g Monday // up to 7 rows whose value is a Monday, Tuesday, Wednesday, Thursday, Friday, Saturday or Sunday ) // Hint telling aggregators which days they can skip // optional, ignored if atom is used 'itunes' => array( 'author' => 'Artist column' // optional, default to the main author value 'owner' => array( 'name' => 'name of the owner' // optional, default to main author value 'email' => 'email of the owner' // optional, default to main email value ) // Owner of the podcast // optional 'image' => 'album/podcast art' // optional, default to the main image value 'subtitle' => 'short description' // optional, default to the main description value 'summary' => 'longer description' // optional, default to the main description value 'block' => 'Prevent an episode from appearing (yes|no)' // optional 'category' => array( array('main' => 'main category', // required 'sub' => 'sub category' // optional ), // up to 3 rows ) // 'Category column and in iTunes Music Store Browse' // required 'explicit' => 'parental advisory graphic (yes|no|clean)' // optional 'keywords' => 'a comma separated list of 12 keywords maximum' // optional 'new-feed-url' => 'used to inform iTunes of new feed URL location' // optional ) // Itunes extension data // optional, ignored if atom is used 'entries' => array( array( 'title' => 'title of the feed entry', //required 'link' => 'url to a feed entry', //required 'description' => 'short version of a feed entry', // only text, no html, required 'guid' => 'id of the article, if not given link value will used', //optional 'content' => 'long version', // can contain html, optional 'lastUpdate' => 'timestamp of the publication date', // optional 'comments' => 'comments page of the feed entry', // optional 'commentRss' => 'the feed url of the associated comments', // optional 'source' => array( 'title' => 'title of the original source' // required, 'url' => 'url of the original source' // required ) // original source of the feed entry // optional 'category' => array( array( 'term' => 'first category label' // required, 'scheme' => 'url that identifies a categorization scheme' // optional ), array( //data for the second category and so on ) ) // list of the attached categories // optional 'enclosure' => array( array( 'url' => 'url of the linked enclosure' // required 'type' => 'mime type of the enclosure' // optional 'length' => 'length of the linked content in octets' // optional ), array( //data for the second enclosure and so on ) ) // list of the enclosures of the feed entry // optional ), array( //data for the second entry and so on ) ) );

Parameters
Name Type Description
$data array
methodprotected_createEntries( array $data ) : void

Create the array of article entries

Parameters
Name Type Description
$data array
Throws
Exception Description
\Zend_Feed_Builder_Exception
methodprotected_createHeader( array $data ) : void

Create the Zend_Feed_Builder_Header instance

Parameters
Name Type Description
$data array
Throws
Exception Description
\Zend_Feed_Builder_Exception
methodpublicgetEntries( ) : array

Returns an array of Zend_Feed_Builder_Entry instances describing the entries of the feed

Returns
Type Description
array of Zend_Feed_Builder_Entry
methodpublicgetHeader( ) : \Zend_Feed_Builder_Header

Returns an instance of Zend_Feed_Builder_Header describing the header of the feed

Returns
Type Description
\Zend_Feed_Builder_Header
Documentation was generated by DocBlox 0.15.1.