<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Zend Framework API Documentation</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><link rel="stylesheet" href="css/black-tie/jquery-ui-1.8.2.custom.css" type="text/css"></link><link rel="stylesheet" href="css/jquery.treeview.css" type="text/css"></link><link rel="stylesheet" href="css/theme.css" type="text/css"></link><script type="text/javascript" src="js/jquery-1.4.2.min.js"></script><script type="text/javascript" src="js/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="js/jquery.cookie.js"></script><script type="text/javascript" src="js/jquery.treeview.js"></script><script type="text/javascript">
            $(document).ready(function() {
                $(".filetree").treeview({
                    collapsed: true,
                    persist: "cookie"
                });

                $("#accordion").accordion({
                    collapsible: true,
                    autoHeight:  false,
                    fillSpace:   true
                });

                $(".tabs").tabs();
            });
        </script></head><body><div xmlns="" class="content">
<div class="sub-page-main-header-api-documentation"><h2>API Documentation</h2></div>
<div class="dotted-line"></div>
</div>
<div xmlns="" id="content">
<script type="text/javascript" src="js/menu.js"></script><script>
      $(document).ready(function() {
        $('a.gripper').click(function() {
            $(this).nextAll('div.code-tabs').slideToggle();
            $(this).children('img').toggle();
            return false;
        });
        $('div.code-tabs').hide();
        $('a.gripper').show();
        $('div.file-nav').show();
      });
    </script><h1 class="file">Feed/Builder.php</h1>
<div class="file-nav"><ul id="file-nav">
<li><a href="#top">Global</a></li>
<li>
<a href="#classes"><img src="images/icons/class.png" height="14">
                      Classes
                  </a><ul><li><a href="#%5CZend_Feed_Builder">\Zend_Feed_Builder</a></li></ul>
</li>
</ul></div>
<a name="top"></a><div id="file-description">
<p class="short-description">Zend Framework</p>
<div class="long-description"><p>LICENSE</p>

<p>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.</p>
</div>
</div>
<dl class="file-info">
<dt>category</dt>
<dd>Zend
         
    </dd>
<dt>copyright</dt>
<dd>Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
         
    </dd>
<dt>license</dt>
<dd>
<a href="http://framework.zend.com/license/new-bsd">New BSD License</a>
         
    </dd>
<dt>package</dt>
<dd>Zend_Feed
         
    </dd>
<dt>version</dt>
<dd>$Id: Builder.php 23775 2011-03-01 17:25:24Z ralph $
         
    </dd>
</dl>
<a name="classes"></a><a id="\Zend_Feed_Builder"></a><h2 class="class">\Zend_Feed_Builder<div class="to-top"><a href="#top">jump to top</a></div>
</h2>
<div class="class">
<p class="short-description">A simple implementation of Zend_Feed_Builder_Interface.</p>
<div class="long-description"><p>Users are encouraged to make their own classes to implement Zend_Feed_Builder_Interface</p>
</div>
<dl class="class-info">
<dt>Implements</dt>
<dd><a href="db_Feed_Builder_Interface.html#%5CZend_Feed_Builder_Interface">\Zend_Feed_Builder_Interface</a></dd>
<dt>category</dt>
<dd>Zend
         
    </dd>
<dt>copyright</dt>
<dd>Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
         
    </dd>
<dt>license</dt>
<dd>
<a href="http://framework.zend.com/license/new-bsd">New BSD License</a>
         
    </dd>
<dt>package</dt>
<dd>Zend_Feed
         
    </dd>
</dl>
<h3>Properties</h3>
<div>
<a id="\Zend_Feed_Builder::$_data"></a><div class="property">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_private.png" style="margin-right: 5px" alt="private">\$_data
                 <span class="highlight">$_data</span>= ''
                </code><div class="description">
<p class="short-description">The data of the feed</p>array</div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>\$_data</dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\Zend_Feed_Builder::$_entries"></a><div class="property">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_private.png" style="margin-right: 5px" alt="private">\$_entries
                 <span class="highlight">$_entries</span>= 'array'
                </code><div class="description">
<p class="short-description">List of the entries of the feed</p>array</div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Default value</strong><code>array</code><strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>\$_entries</dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="\Zend_Feed_Builder::$_header"></a><div class="property">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_private.png" style="margin-right: 5px" alt="private">\$_header
                 <span class="highlight">$_header</span>= ''
                </code><div class="description">
<p class="short-description">Header of the feed</p>Zend_Feed_Builder_Header</div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd>\$_header</dd>
</dl>
</div>
<div class="clear"></div>
</div>
</div>
<h3>Methods</h3>
<div>
<a id="\Zend_Feed_Builder::__construct()"></a><div class="method">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">__construct</span><span class="nb-faded-text">(
          array $data
          )
        </span>
        :
          void</code><div class="description"><p class="short_description">Constructor. The $data array must conform to the following format:
<code>
 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
                  )
                )
);
</code></p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$data</th>
<td>array</td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\Zend_Feed_Builder::_createEntries()"></a><div class="method">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"><span class="highlight">_createEntries</span><span class="nb-faded-text">(
          array $data
          )
        </span>
        :
          void</code><div class="description"><p class="short_description">Create the array of article entries</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$data</th>
<td>array</td>
<td><em></em></td>
</tr>
</table>
<strong>Throws</strong><table class="argument-info">
<thead><tr>
<th>Exception</th>
<th>Description</th>
</tr></thead>
<tr>
<td><a href="db_Feed_Builder_Exception.html#%5CZend_Feed_Builder_Exception">\Zend_Feed_Builder_Exception</a></td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\Zend_Feed_Builder::_createHeader()"></a><div class="method">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"><span class="highlight">_createHeader</span><span class="nb-faded-text">(
          array $data
          )
        </span>
        :
          void</code><div class="description"><p class="short_description">Create the Zend_Feed_Builder_Header instance</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$data</th>
<td>array</td>
<td><em></em></td>
</tr>
</table>
<strong>Throws</strong><table class="argument-info">
<thead><tr>
<th>Exception</th>
<th>Description</th>
</tr></thead>
<tr>
<td><a href="db_Feed_Builder_Exception.html#%5CZend_Feed_Builder_Exception">\Zend_Feed_Builder_Exception</a></td>
<td><em></em></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\Zend_Feed_Builder::getEntries()"></a><div class="method">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">getEntries</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          array</code><div class="description"><p class="short_description">Returns an array of Zend_Feed_Builder_Entry instances
describing the entries of the feed</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td>array</td>
<td>of Zend_Feed_Builder_Entry</td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\Zend_Feed_Builder::getHeader()"></a><div class="method">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">getHeader</span><span class="nb-faded-text">(
          
          )
        </span>
        :
          <a href="db_Feed_Builder_Header.html#%5CZend_Feed_Builder_Header">\Zend_Feed_Builder_Header</a></code><div class="description"><p class="short_description">Returns an instance of Zend_Feed_Builder_Header
describing the header of the feed</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td><a href="db_Feed_Builder_Header.html#%5CZend_Feed_Builder_Header">\Zend_Feed_Builder_Header</a></td>
<td></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
</div>
</div>
</div>
<small xmlns="" class="footer">Documentation was generated by <a href="http://docblox-project.org">DocBlox 0.13.3</a>.
    </small></body></html>
