## Zend_Gdata_App_Feed

Description

Implements interfaces:

- Iterator (internal interface)
- ArrayAccess (internal interface)
- Countable (internal interface)

Atom feed class

- copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license: New BSD License

Located in /Gdata/App/Feed.php (line 43)

    Zend_Gdata_App_Base
       |
       --Zend_Gdata_App_FeedEntryParent
          |
          --Zend_Gdata_App_FeedSourceParent
             |
             --Zend_Gdata_App_Feed

Direct descendents

Class | Description
--- | ---
Zend_Gdata_Feed | The Gdata flavor of an Atom Feed

Variable Summary
array $_entry
int $_entryIndex
string $_rootElement
Method Summary
Zend_Gdata_App_Feed addEntry (Zend_Gdata_App_Entry $value)
integer count ()
mixed current ()
DOMElement getDOM ([DOMDocument $doc = null], [ $majorVersion = 1], [ $minorVersion = null])
array getEntry ()
mixed|null getNextFeed ()
mixed|null getPreviousFeed ()
mixed key ()
mixed next ()
boolean offsetExists (int $key)
void offsetGet (int $key, Zend_Gdata_App_Entry $value)
void offsetSet (int $key, Zend_Gdata_App_Entry $value)
void offsetUnset (int $key, Zend_Gdata_App_Entry $value)
void rewind ()
Zend_Gdata_App_Feed setEntry (array $value)
void setMajorProtocolVersion ((int|NULL) $value)
void setMinorProtocolVersion ((int|NULL) $value)
void takeChildFromDOM (DOMNode $child)
boolean valid ()
mixed __get (string $var)
Variables
array $_entry = array() (line 59)

Cache of feed entries.

- access: protected

int $_entryIndex = 0 (line 66)

Current location in $_entry array

- access: protected

string $_rootElement = 'feed' (line 52)

The root xml element of this data element

- access: protected

Redefinition of:

Zend_Gdata_App_FeedSourceParent::$_rootElement
  Root XML element for Atom entries.

#### Inherited Variables

Inherited from Zend_Gdata_App_FeedSourceParent

> Zend_Gdata_App_FeedSourceParent::$_entryClassName
> Zend_Gdata_App_FeedSourceParent::$_generator
> Zend_Gdata_App_FeedSourceParent::$_icon
> Zend_Gdata_App_FeedSourceParent::$_logo
> Zend_Gdata_App_FeedSourceParent::$_subtitle

Inherited from Zend_Gdata_App_FeedEntryParent

> Zend_Gdata_App_FeedEntryParent::$_author
> Zend_Gdata_App_FeedEntryParent::$_category
> Zend_Gdata_App_FeedEntryParent::$_contributor
> Zend_Gdata_App_FeedEntryParent::$_etag
> Zend_Gdata_App_FeedEntryParent::$_id
> Zend_Gdata_App_FeedEntryParent::$_link
> Zend_Gdata_App_FeedEntryParent::$_majorProtocolVersion
> Zend_Gdata_App_FeedEntryParent::$_minorProtocolVersion
> Zend_Gdata_App_FeedEntryParent::$_rights
> Zend_Gdata_App_FeedEntryParent::$_service
> Zend_Gdata_App_FeedEntryParent::$_title
> Zend_Gdata_App_FeedEntryParent::$_updated

Inherited from Zend_Gdata_App_Base

> Zend_Gdata_App_Base::$_extensionAttributes
> Zend_Gdata_App_Base::$_extensionElements
> Zend_Gdata_App_Base::$_namespaceLookupCache
> Zend_Gdata_App_Base::$_namespaces
> Zend_Gdata_App_Base::$_rootNamespace
> Zend_Gdata_App_Base::$_rootNamespaceURI
> Zend_Gdata_App_Base::$_text

Methods
addEntry (line 218)

Adds an entry representation to the array of entries contained within this feed

- return: Provides a fluent interface
- access: public

Zend_Gdata_App_Feed addEntry (Zend_Gdata_App_Entry $value)

- Zend_Gdata_App_Entry $value: An individual entry to add.

count (line 132)

Get the number of entries in this feed object.

- return: Entry count.
- access: public

integer count ()

Implementation of:

Countable::count

current (line 152)

Required by the Iterator interface.

- return: The current row, or null if no rows.
- access: public

mixed current ()

Implementation of:

Iterator::current

getDOM (line 95)

Retrieves the DOM model representing this object and all children

- access: public

DOMElement getDOM ([DOMDocument $doc = null], [ $majorVersion = 1], [ $minorVersion = null])

- DOMDocument $doc
- $majorVersion
- $minorVersion

Redefinition of:

Zend_Gdata_App_FeedSourceParent::getDOM()

Redefined in descendants as:

- Zend_Gdata_Feed::getDOM()
- Zend_Gdata_Calendar_EventFeed::getDOM()
- Zend_Gdata_Calendar_ListFeed::getDOM()
- Zend_Gdata_Photos_AlbumFeed::getDOM()
- Zend_Gdata_Photos_UserFeed::getDOM()
- Zend_Gdata_Photos_PhotoFeed::getDOM()
- Zend_Gdata_Spreadsheets_CellFeed::getDOM()

getEntry (line 193)

Gets the array of atom:entry elements contained within this atom:feed representation

- return: Zend_Gdata_App_Entry array
- access: public

array getEntry ()
getNextFeed (line 280)

Retrieve the next set of results from this feed.

- return: Returns the next set of results as a feed of the same class as this feed, or null if no results exist.
- throws: Zend_Gdata_App_Exception
- access: public

mixed|null getNextFeed ()
getPreviousFeed (line 301)

Retrieve the previous set of results from this feed.

- return: Returns the previous set of results as a feed of the same class as this feed, or null if no results exist.
- throws: Zend_Gdata_App_Exception
- access: public

mixed|null getPreviousFeed ()
key (line 162)

Required by the Iterator interface.

- return: The current row number (starts at 0), or NULL if no rows
- access: public

mixed key ()

Implementation of:

Iterator::key

next (line 172)

Required by the Iterator interface.

- return: The next row, or null if no more rows.
- access: public

mixed next ()

Implementation of:

Iterator::next

offsetExists (line 268)

Required by the ArrayAccess interface

- access: public

boolean offsetExists (int $key)

- int $key: The index to check for existence

Implementation of:

ArrayAccess::offsetExists

offsetGet (line 242)

Required by the ArrayAccess interface

- access: public

void offsetGet (int $key, Zend_Gdata_App_Entry $value)

- int $key: The index to get
- Zend_Gdata_App_Entry $value: The value to set

Implementation of:

ArrayAccess::offsetGet

offsetSet (line 231)

Required by the ArrayAccess interface

- access: public

void offsetSet (int $key, Zend_Gdata_App_Entry $value)

- int $key: The index to set
- Zend_Gdata_App_Entry $value: The value to set

Implementation of:

ArrayAccess::offsetSet

offsetUnset (line 255)

Required by the ArrayAccess interface

- access: public

void offsetUnset (int $key, Zend_Gdata_App_Entry $value)

- int $key: The index to set
- Zend_Gdata_App_Entry $value: The value to set

Implementation of:

ArrayAccess::offsetUnset

rewind (line 142)

Required by the Iterator interface.

- access: public

void rewind ()

Implementation of:

Iterator::rewind

setEntry (line 205)

Sets the array of atom:entry elements contained within this atom:feed representation

- return: Provides a fluent interface
- access: public

Zend_Gdata_App_Feed setEntry (array $value)

- array $value: The array of Zend_Gdata_App_Entry elements

setMajorProtocolVersion (line 325)

Set the major protocol version that should be used. Values < 1 will cause a Zend_Gdata_App_InvalidArgumentException to be thrown.

This value will be propogated to all child entries.

- see: Zend_Gdata_App_FeedEntryParent::$_majorProtocolVersion
- throws: Zend_Gdata_App_InvalidArgumentException
- access: public

void setMajorProtocolVersion ((int|NULL) $value)

- (int|NULL) $value: The major protocol version to use.

Redefinition of:

Zend_Gdata_App_FeedEntryParent::setMajorProtocolVersion()
  Set the major protocol version that should be used. Values < 1 (excluding NULL) will cause a Zend_Gdata_App_InvalidArgumentException to be thrown.

setMinorProtocolVersion (line 344)

Set the minor protocol version that should be used. If set to NULL, no minor protocol version will be sent to the server. Values < 0 will cause a Zend_Gdata_App_InvalidArgumentException to be thrown.

This value will be propogated to all child entries.

- see: Zend_Gdata_App_FeedEntryParent::$_minorProtocolVersion
- throws: Zend_Gdata_App_InvalidArgumentException
- access: public

void setMinorProtocolVersion ((int|NULL) $value)

- (int|NULL) $value: The minor protocol version to use.

Redefinition of:

Zend_Gdata_App_FeedEntryParent::setMinorProtocolVersion()
  Set the minor protocol version that should be used. If set to NULL, no minor protocol version will be sent to the server. Values < 0 will cause a Zend_Gdata_App_InvalidArgumentException to be thrown.

takeChildFromDOM (line 110)

Creates individual Entry objects of the appropriate type and stores them in the $_entry array based upon DOM data.

- access: protected

void takeChildFromDOM (DOMNode $child)

- DOMNode $child: The DOMNode to process

Redefinition of:

Zend_Gdata_App_FeedSourceParent::takeChildFromDOM()
  Creates individual Entry objects of the appropriate type and stores them in the $_entry array based upon DOM data.

Redefined in descendants as:

- Zend_Gdata_Feed::takeChildFromDOM() : Creates individual Entry objects of the appropriate type and stores them in the $_entry array based upon DOM data.
- Zend_Gdata_Calendar_EventFeed::takeChildFromDOM()
- Zend_Gdata_Calendar_ListFeed::takeChildFromDOM()
- Zend_Gdata_Photos_AlbumFeed::takeChildFromDOM()
- Zend_Gdata_Photos_UserFeed::takeChildFromDOM() : Creates individual Entry objects of the appropriate type and stores them in the $_entry array based upon DOM data.
- Zend_Gdata_Photos_PhotoFeed::takeChildFromDOM()
- Zend_Gdata_Spreadsheets_CellFeed::takeChildFromDOM()

valid (line 182)

Required by the Iterator interface.

- return: Whether the iteration is valid
- access: public

boolean valid ()

Implementation of:

Iterator::valid

__get (line 79)

Make accessing some individual elements of the feed easier.

Special accessors 'entry' and 'entries' are provided so that if you wish to iterate over an Atom feed's entries, you can do so using foreach ($feed->entries as $entry) or foreach ($feed->entry as $entry).

- access: public

mixed __get (string $var)

- string $var: The property to get.

Redefinition of:

Zend_Gdata_App_FeedSourceParent::__get()
  Make accessing some individual elements of the feed easier.

#### Inherited Methods

Inherited From Zend_Gdata_App_FeedSourceParent

> Zend_Gdata_App_FeedSourceParent::getDOM()
> Zend_Gdata_App_FeedSourceParent::getGenerator()
> Zend_Gdata_App_FeedSourceParent::getIcon()
> Zend_Gdata_App_FeedSourceParent::getlogo()
> Zend_Gdata_App_FeedSourceParent::getSubtitle()
> Zend_Gdata_App_FeedSourceParent::setGenerator()
> Zend_Gdata_App_FeedSourceParent::setHttpClient()
> Zend_Gdata_App_FeedSourceParent::setIcon()
> Zend_Gdata_App_FeedSourceParent::setlogo()
> Zend_Gdata_App_FeedSourceParent::setService()
> Zend_Gdata_App_FeedSourceParent::setSubtitle()
> Zend_Gdata_App_FeedSourceParent::takeChildFromDOM()
> Zend_Gdata_App_FeedSourceParent::__get()

Inherited From Zend_Gdata_App_FeedEntryParent

> Zend_Gdata_App_FeedEntryParent::__construct()
> Zend_Gdata_App_FeedEntryParent::getAlternateLink()
> Zend_Gdata_App_FeedEntryParent::getAuthor()
> Zend_Gdata_App_FeedEntryParent::getCategory()
> Zend_Gdata_App_FeedEntryParent::getContributor()
> Zend_Gdata_App_FeedEntryParent::getDOM()
> Zend_Gdata_App_FeedEntryParent::getEditLink()
> Zend_Gdata_App_FeedEntryParent::getEtag()
> Zend_Gdata_App_FeedEntryParent::getHttpClient()
> Zend_Gdata_App_FeedEntryParent::getId()
> Zend_Gdata_App_FeedEntryParent::getLicenseLink()
> Zend_Gdata_App_FeedEntryParent::getLink()
> Zend_Gdata_App_FeedEntryParent::getMajorProtocolVersion()
> Zend_Gdata_App_FeedEntryParent::getMinorProtocolVersion()
> Zend_Gdata_App_FeedEntryParent::getNextLink()
> Zend_Gdata_App_FeedEntryParent::getPreviousLink()
> Zend_Gdata_App_FeedEntryParent::getRights()
> Zend_Gdata_App_FeedEntryParent::getSelfLink()
> Zend_Gdata_App_FeedEntryParent::getService()
> Zend_Gdata_App_FeedEntryParent::getTitle()
> Zend_Gdata_App_FeedEntryParent::getTitleValue()
> Zend_Gdata_App_FeedEntryParent::getUpdated()
> Zend_Gdata_App_FeedEntryParent::lookupNamespace()
> Zend_Gdata_App_FeedEntryParent::setAuthor()
> Zend_Gdata_App_FeedEntryParent::setCategory()
> Zend_Gdata_App_FeedEntryParent::setContributor()
> Zend_Gdata_App_FeedEntryParent::setEtag()
> Zend_Gdata_App_FeedEntryParent::setHttpClient()
> Zend_Gdata_App_FeedEntryParent::setId()
> Zend_Gdata_App_FeedEntryParent::setLink()
> Zend_Gdata_App_FeedEntryParent::setMajorProtocolVersion()
> Zend_Gdata_App_FeedEntryParent::setMinorProtocolVersion()
> Zend_Gdata_App_FeedEntryParent::setRights()
> Zend_Gdata_App_FeedEntryParent::setService()
> Zend_Gdata_App_FeedEntryParent::setTitle()
> Zend_Gdata_App_FeedEntryParent::setUpdated()
> Zend_Gdata_App_FeedEntryParent::takeChildFromDOM()

Inherited From Zend_Gdata_App_Base

> Zend_Gdata_App_Base::__construct()
> Zend_Gdata_App_Base::encode()
> Zend_Gdata_App_Base::flushNamespaceLookupCache()
> Zend_Gdata_App_Base::getDOM()
> Zend_Gdata_App_Base::getExtensionAttributes()
> Zend_Gdata_App_Base::getExtensionElements()
> Zend_Gdata_App_Base::getText()
> Zend_Gdata_App_Base::getXML()
> Zend_Gdata_App_Base::lookupNamespace()
> Zend_Gdata_App_Base::registerAllNamespaces()
> Zend_Gdata_App_Base::registerNamespace()
> Zend_Gdata_App_Base::saveXML()
> Zend_Gdata_App_Base::setExtensionAttributes()
> Zend_Gdata_App_Base::setExtensionElements()
> Zend_Gdata_App_Base::setText()
> Zend_Gdata_App_Base::takeAttributeFromDOM()
> Zend_Gdata_App_Base::takeChildFromDOM()
> Zend_Gdata_App_Base::transferFromDOM()
> Zend_Gdata_App_Base::transferFromXML()
> Zend_Gdata_App_Base::__get()
> Zend_Gdata_App_Base::__isset()
> Zend_Gdata_App_Base::__set()
> Zend_Gdata_App_Base::__toString()
> Zend_Gdata_App_Base::__unset()

Documentation generated on Tue, 26 Oct 2010 20:08:44 +0400 by phpDocumentor 1.4.2