Feed/Writer/Feed.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Feed_Writer
version: $Id: Feed.php 20519 2010-01-22 14:06:24Z padraic $
Classes: Zend_Feed_Writer_Feed

Description

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.

Zend_Feed_Writer_Feed
jump to top

Extends from: Zend_Feed_Writer_Feed_FeedAbstract
Implements
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Feed_Writer
Properties: $_entries; $_entriesKey
Methods: createEntry; addTombstone; createTombstone; addEntry; removeEntry; getEntry; orderByDate; count; current; key; next; rewind; valid; export

Description

Properties

$_entries
jump to class

array $_entries = 'array'

Contains all entry objects

Details

$_entries: array
visibility: protected
default: array
final: false
static: false

$_entriesKey
jump to class

int $_entriesKey = '0'

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

Details

$_entriesKey: int
visibility: protected
default: 0
final: false
static: false

Methods

addEntry
jump to class

addEntry(
          Zend_Feed_Writer_Entry $entry
          )
        
        :

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

Arguments

$entry: Zend_Feed_Writer_Entry

Details

visibility: public
final: false
static: false

addTombstone
jump to class

addTombstone(
           $deleted
          )
        
        :

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

Arguments

$deleted

Details

visibility: public
final: false
static: false

count
jump to class

Get the number of feed entries.

Required by the Iterator interface.

Output

int

Details

visibility: public
final: false
static: false

createEntry
jump to class

createEntry(
          
          )
        
        :
        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.

Output

Zend_Feed_Writer_Entry

Details

visibility: public
final: false
static: false

createTombstone
jump to class

createTombstone(
          
          )
        
        :
        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.

Output

Zend_Feed_Writer_Deleted

Details

visibility: public
final: false
static: false

current
jump to class

current(
          
          )
        
        :
        Zend_Feed_Reader_Entry_Interface

Return the current entry

Output

Zend_Feed_Reader_Entry_Interface

Details

visibility: public
final: false
static: false

export
jump to class

export(
          $type $type,  $ignoreExceptions
              =
              false
          )
        
        :
        string

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

Arguments

$type: $type
The feed type "rss" or "atom" to export as
$ignoreExceptions

Output

string

Details

visibility: public
final: false
static: false

getEntry
jump to class

getEntry(
          int $index
              =
              0
          )
        
        :

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

Arguments

$index: int

Details

visibility: public
final: false
static: false

key
jump to class

key(
          
          )
        
        :
        unknown

Return the current feed key

Output

unknown

Details

visibility: public
final: false
static: false

next
jump to class

Move the feed pointer forward

Details

visibility: public
final: false
static: false

orderByDate
jump to class

orderByDate(
          
          )
        
        :
        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.

Details

visibility: public
final: false
static: false

removeEntry
jump to class

removeEntry(
          int $index
          )
        
        :

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

Arguments

$index: int

Details

visibility: public
final: false
static: false

rewind
jump to class

rewind(
          
          )
        
        :
        void

Reset the pointer in the feed object

Details

visibility: public
final: false
static: false

valid
jump to class

valid(
          
          )
        
        :
        boolean

Check to see if the iterator is still valid

Output

boolean

Details

visibility: public
final: false
static: false

API Documentation

Feed/Writer/Feed.php

Description

Zend_Feed_Writer_Feedjump to top

Description

Properties

$_entriesjump to class

Details

$_entriesKeyjump to class

Details

Methods

addEntryjump to class

Arguments

Details

addTombstonejump to class

Arguments

Details

countjump to class

Output

Details

createEntryjump to class

Output

Details

createTombstonejump to class

Output

Details

currentjump to class

Output

Details

exportjump to class

Arguments

Output

Details

getEntryjump to class

Arguments

Details

keyjump to class

Output

Details

nextjump to class

Details

orderByDatejump to class

Details

removeEntryjump to class

Arguments

Details

rewindjump to class

Details

validjump to class

Output

Details

Zend_Feed_Writer_Feed
jump to top

$_entries
jump to class

$_entriesKey
jump to class

addEntry
jump to class

addTombstone
jump to class

count
jump to class

createEntry
jump to class

createTombstone
jump to class

current
jump to class

export
jump to class

getEntry
jump to class

key
jump to class

next
jump to class

orderByDate
jump to class

removeEntry
jump to class

rewind
jump to class

valid
jump to class