API Documentation

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

\Zend_Feed_Writer_Feed

Package: Zend\Feed\Writer

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

Properties

Propertyprotectedarray  $_entries= 'array()'

Contains all entry objects

Default valuearray()Details
Type
array
Propertyprotectedint  $_entriesKey= '0'

A pointer for the iterator to keep track of the entries array

Default value0Details
Type
int

Methods

methodpublicaddEntry( \Zend_Feed_Writer_Entry $entry ) : void

Appends a Zend_Feed_Writer_Entry object representing a new entry/item the feed data container's internal group of entries.

Parameters
Name Type Description
$entry \Zend_Feed_Writer_Entry
methodpublicaddTombstone(  $deleted ) : void

Appends a Zend_Feed_Writer_Deleted object representing a new entry tombstone to the feed data container's internal group of entries.

Parameters
Name Type Description
$deleted
methodpubliccount( ) : int

Get the number of feed entries.

Required by the Iterator interface.

Returns
Type Description
int
methodpubliccreateEntry( ) : \Zend_Feed_Writer_Entry

Creates a new Zend_Feed_Writer_Entry data container for use. This is NOT added to the current feed automatically, but is necessary to create a container with some initial values preset based on the current feed data.

Returns
Type Description
\Zend_Feed_Writer_Entry
methodpubliccreateTombstone( ) : \Zend_Feed_Writer_Deleted

Creates a new Zend_Feed_Writer_Deleted data container for use. This is NOT added to the current feed automatically, but is necessary to create a container with some initial values preset based on the current feed data.

Returns
Type Description
\Zend_Feed_Writer_Deleted
methodpubliccurrent( ) : \Zend_Feed_Reader_Entry_Interface

Return the current entry

Returns
Type Description
\Zend_Feed_Reader_Entry_Interface
methodpublicexport( string $type, bool $ignoreExceptions = false ) : string

Attempt to build and return the feed resulting from the data set

Parameters
Name Type Description
$type string

The feed type "rss" or "atom" to export as

$ignoreExceptions bool
Returns
Type Description
string
methodpublicgetEntry( int $index = 0 ) : void

Retrieve a specific indexed entry from the internal queue. Entries must be added to a feed container in order to be indexed.

Parameters
Name Type Description
$index int
methodpublickey( ) : \unknown

Return the current feed key

Returns
Type Description
\unknown
methodpublicnext( ) : void

Move the feed pointer forward

methodpublicorderByDate( ) : void

Orders all indexed entries by date, thus offering date ordered readable content where a parser (or Homo Sapien) ignores the generic rule that XML element order is irrelevant and has no intrinsic meaning.

Using this method will alter the original indexation.

methodpublicremoveEntry( int $index ) : void

Removes a specific indexed entry from the internal queue. Entries must be added to a feed container in order to be indexed.

Parameters
Name Type Description
$index int
methodpublicrewind( ) : void

Reset the pointer in the feed object

methodpublicvalid( ) : boolean

Check to see if the iterator is still valid

Returns
Type Description
boolean
Documentation was generated by DocBlox 0.15.1.