## Zend_Gdata_Feed

Description

The Gdata flavor of an Atom Feed

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

Located in /Gdata/Feed.php (line 63)

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

Direct descendents

Class | Description
--- | ---
Zend_Gdata_Geo_Feed | Feed for Gdata Geographic data entries.
Zend_Gdata_Media_Feed | The Gdata flavor of an Atom Feed with media support
Zend_Gdata_Books_CollectionFeed | Describes a Book Search collection feed
Zend_Gdata_Books_VolumeFeed | Describes a Book Search volume feed
Zend_Gdata_Gbase_Feed | Base class for the Google Base Feed
Zend_Gdata_Gbase_SnippetFeed | Represents the Google Base Snippets Feed
Zend_Gdata_Gbase_ItemFeed | Represents the Google Base Customer Items Feed
Zend_Gdata_YouTube_ActivityFeed | A feed of user activity entries for YouTube
Zend_Gdata_YouTube_CommentFeed | The YouTube comments flavor of an Atom Feed
Zend_Gdata_Docs_DocumentListFeed | Data model for a Google Documents List feed of documents
Zend_Gdata_Health_ProfileListFeed | Represents a Google Health user's Profile List Feed
Zend_Gdata_Health_ProfileFeed | Represents a Google Health user's Profile Feed
Zend_Gdata_Calendar_EventFeed | Data model for a Google Calendar feed of events
Zend_Gdata_Calendar_ListFeed | Represents the meta-feed list of calendars
Zend_Gdata_Gapps_OwnerFeed | Data model for a collection of Google Apps owner entries, usually provided by the Google Apps servers.
Zend_Gdata_Gapps_UserFeed | Data model for a collection of Google Apps user entries, usually provided by the Google Apps servers.
Zend_Gdata_Gapps_NicknameFeed | Data model for a collection of Google Apps nickname entries, usually provided by the Google Apps servers.
Zend_Gdata_Gapps_EmailListFeed | Data model for a collection of Google Apps email list entries, usually provided by the Google Apps servers.
Zend_Gdata_Gapps_GroupFeed | Data model for a collection of Google Apps group entries, usually provided by the Google Apps servers.
Zend_Gdata_Gapps_MemberFeed | Data model for a collection of Google Apps member entries, usually provided by the Google Apps servers.
Zend_Gdata_Gapps_EmailListRecipientFeed | Data model for a collection of Google Apps email list recipient entries, usually provided by the Google Apps servers.
Zend_Gdata_Photos_AlbumFeed | Data model for a collection of album entries, usually provided by the servers.
Zend_Gdata_Photos_UserFeed | Data model for a collection of entries for a specific user, usually provided by the servers.
Zend_Gdata_Photos_PhotoFeed | Data model for a collection of photo entries, usually provided by the Picasa servers.
Zend_Gdata_Exif_Feed | Feed for Gdata EXIF data entries.
Zend_Gdata_Spreadsheets_SpreadsheetFeed |
Zend_Gdata_Spreadsheets_WorksheetFeed |
Zend_Gdata_Spreadsheets_CellFeed |
Zend_Gdata_Spreadsheets_ListFeed |

Variable Summary
string $_entryClassName
Zend_Gdata_Extension_OpenSearchItemsPerPage|null $_itemsPerPage
Zend_Gdata_Extension_OpenSearchStartIndex|null $_startIndex
Zend_Gdata_Extension_OpenSearchTotalResults|null $_totalResults
Method Summary
Zend_Gdata_Feed __construct ([ $element = null])
void getDOM ([ $doc = null], [ $majorVersion = 1], [ $minorVersion = null])
Zend_Gdata_Extension_OpenSearchItemsPerPage|null getItemsPerPage ()
Zend_Gdata_Extension_OpenSearchStartIndex|null getStartIndex ()
Zend_Gdata_Extension_OpenSearchTotalResults|null getTotalResults ()
Zend_Gdata_Feed setItemsPerPage (Zend_Gdata_Extension_OpenSearchItemsPerPage|null $value)
Zend_Gdata_Feed setStartIndex (Zend_Gdata_Extension_OpenSearchStartIndex|null $value)
Zend_Gdata_Feed setTotalResults (Zend_Gdata_Extension_OpenSearchTotalResults|null $value)
void takeAttributeFromDOM (DOMNode $attribute)
void takeChildFromDOM (DOMNode $child)
Variables
string $_entryClassName = 'Zend_Gdata_Entry' (line 71)

The classname for individual feed elements.

- access: protected

Redefinition of:

Zend_Gdata_App_FeedSourceParent::$_entryClassName
  The classname for individual feed elements.

Redefined in descendants as:

- Zend_Gdata_Geo_Feed::$_entryClassName : The classname for individual feed elements.
- Zend_Gdata_Media_Feed::$_entryClassName : The classname for individual feed elements.
- Zend_Gdata_YouTube_InboxFeed::$_entryClassName : The classname for individual feed elements.
- Zend_Gdata_YouTube_VideoFeed::$_entryClassName : The classname for individual feed elements.
- Zend_Gdata_YouTube_ContactFeed::$_entryClassName : The classname for individual feed elements.
- Zend_Gdata_YouTube_PlaylistListFeed::$_entryClassName : The classname for individual feed elements.
- Zend_Gdata_YouTube_SubscriptionFeed::$_entryClassName : The classname for individual feed elements.
- Zend_Gdata_YouTube_PlaylistVideoFeed::$_entryClassName : The classname for individual feed elements.
- Zend_Gdata_Books_CollectionFeed::$_entryClassName : The classname for individual feed elements.
- Zend_Gdata_Books_VolumeFeed::$_entryClassName : The classname for individual feed elements.
- Zend_Gdata_Gbase_SnippetFeed::$_entryClassName : The classname for individual snippet feed elements.
- Zend_Gdata_Gbase_ItemFeed::$_entryClassName : The classname for individual item feed elements.
- Zend_Gdata_YouTube_ActivityFeed::$_entryClassName : The classname for individual feed elements.
- Zend_Gdata_YouTube_CommentFeed::$_entryClassName : The classname for individual feed elements.
- Zend_Gdata_Docs_DocumentListFeed::$_entryClassName : The classname for individual feed elements.
- Zend_Gdata_Health_ProfileListFeed::$_entryClassName : The class name for individual profile feed elements.
- Zend_Gdata_Health_ProfileFeed::$_entryClassName : The class name for individual profile feed elements.
- Zend_Gdata_Calendar_EventFeed::$_entryClassName : The classname for individual feed elements.
- Zend_Gdata_Calendar_ListFeed::$_entryClassName : The classname for individual feed elements.
- Zend_Gdata_Gapps_OwnerFeed::$_entryClassName
- Zend_Gdata_Gapps_UserFeed::$_entryClassName
- Zend_Gdata_Gapps_NicknameFeed::$_entryClassName
- Zend_Gdata_Gapps_EmailListFeed::$_entryClassName
- Zend_Gdata_Gapps_GroupFeed::$_entryClassName
- Zend_Gdata_Gapps_MemberFeed::$_entryClassName
- Zend_Gdata_Gapps_EmailListRecipientFeed::$_entryClassName
- Zend_Gdata_Photos_AlbumFeed::$_entryClassName
- Zend_Gdata_Photos_UserFeed::$_entryClassName
- Zend_Gdata_Photos_PhotoFeed::$_entryClassName
- Zend_Gdata_Exif_Feed::$_entryClassName : The classname for individual feed elements.
- Zend_Gdata_Spreadsheets_SpreadsheetFeed::$_entryClassName : The classname for individual feed elements.
- Zend_Gdata_Spreadsheets_WorksheetFeed::$_entryClassName : The classname for individual feed elements.
- Zend_Gdata_Spreadsheets_CellFeed::$_entryClassName : The classname for individual feed elements.
- Zend_Gdata_Spreadsheets_ListFeed::$_entryClassName : The classname for individual feed elements.

Zend_Gdata_Extension_OpenSearchItemsPerPage|null $_itemsPerPage = null (line 92)

The openSearch:itemsPerPage element

- access: protected

Zend_Gdata_Extension_OpenSearchStartIndex|null $_startIndex = null (line 85)

The openSearch:startIndex element

- access: protected

Zend_Gdata_Extension_OpenSearchTotalResults|null $_totalResults = null (line 78)

The openSearch:totalResults element

- access: protected

#### Inherited Variables

Inherited from Zend_Gdata_App_Feed

> Zend_Gdata_App_Feed::$_entry
> Zend_Gdata_App_Feed::$_entryIndex
> Zend_Gdata_App_Feed::$_rootElement

Inherited from Zend_Gdata_App_FeedSourceParent

> 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
Constructor __construct (line 94)

- access: public

Zend_Gdata_Feed __construct ([ $element = null])

- $element

Redefinition of:

Zend_Gdata_App_FeedEntryParent::__construct()
  Constructs a Feed or Entry

Redefined in descendants as:

- Zend_Gdata_Geo_Feed::__construct()
- Zend_Gdata_Media_Feed::__construct() : Create a new instance.
- Zend_Gdata_YouTube_InboxFeed::__construct() : Creates an Inbox feed, representing a list of messages, associated with an individual user.
- Zend_Gdata_YouTube_VideoFeed::__construct() : Creates a Video feed, representing a list of videos
- Zend_Gdata_YouTube_ContactFeed::__construct() : Constructs a new YouTube Contact Feed object, to represent a feed of contacts for a user
- Zend_Gdata_YouTube_PlaylistListFeed::__construct() : Creates a Playlist list feed, representing a list of playlists, usually associated with an individual user.
- Zend_Gdata_YouTube_SubscriptionFeed::__construct() : Creates a Subscription feed, representing a list of subscriptions, usually associated with an individual user.
- Zend_Gdata_YouTube_PlaylistVideoFeed::__construct() : Creates a Play Video feed, representing a list of videos contained within a single playlist.
- Zend_Gdata_Books_CollectionFeed::__construct() : Constructor for Zend_Gdata_Books_CollectionFeed which Describes a Book Search collection feed
- Zend_Gdata_Books_VolumeFeed::__construct() : Constructor for Zend_Gdata_Books_VolumeFeed which Describes a Book Search volume feed
- Zend_Gdata_Gbase_Feed::__construct() : Create a new instance.
- Zend_Gdata_YouTube_ActivityFeed::__construct() : Creates an Activity feed, representing a list of activity entries
- Zend_Gdata_YouTube_CommentFeed::__construct() : Constructs a new YouTube Comment Feed object, to represent a feed of comments for an individual video
- Zend_Gdata_Docs_DocumentListFeed::__construct() : Create a new instance of a feed for a list of documents.
- Zend_Gdata_Health_ProfileFeed::__construct() : Creates a Health Profile feed, representing a user's Health profile
- Zend_Gdata_Calendar_EventFeed::__construct()
- Zend_Gdata_Calendar_ListFeed::__construct()
- Zend_Gdata_Photos_AlbumFeed::__construct()
- Zend_Gdata_Photos_UserFeed::__construct()
- Zend_Gdata_Photos_PhotoFeed::__construct()
- Zend_Gdata_Exif_Feed::__construct() : Create a new instance.
- Zend_Gdata_Spreadsheets_SpreadsheetFeed::__construct() : Constructs a new Zend_Gdata_Spreadsheets_SpreadsheetFeed object.
- Zend_Gdata_Spreadsheets_WorksheetFeed::__construct() : Constructs a new Zend_Gdata_Spreadsheets_WorksheetFeed object.
- Zend_Gdata_Spreadsheets_CellFeed::__construct() : Constructs a new Zend_Gdata_Spreadsheets_CellFeed object.
- Zend_Gdata_Spreadsheets_ListFeed::__construct() : Constructs a new Zend_Gdata_Spreadsheets_ListFeed object.

getDOM (line 100)

- access: public

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

- $doc
- $majorVersion
- $minorVersion

Redefinition of:

Zend_Gdata_App_Feed::getDOM()
  Retrieves the DOM model representing this object and all children

Redefined in descendants as:

- 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()

getItemsPerPage (line 247)

Get the value of the itemsPerPage property.

- return: The value of the itemsPerPage property, or null if unset.

Zend_Gdata_Extension_OpenSearchItemsPerPage|null getItemsPerPage ()
getStartIndex (line 225)

Get the value of the startIndex property.

- return: The value of the startIndex property, or null if unset.

Zend_Gdata_Extension_OpenSearchStartIndex|null getStartIndex ()
getTotalResults (line 203)

Get the value of the totalResults property.

- return: The value of the totalResults property, or null if unset.

Zend_Gdata_Extension_OpenSearchTotalResults|null getTotalResults ()
setItemsPerPage (line 236)

Set the itemsPerPage property.

- return: Provides a fluent interface.

Zend_Gdata_Feed setItemsPerPage (Zend_Gdata_Extension_OpenSearchItemsPerPage|null $value)

- Zend_Gdata_Extension_OpenSearchItemsPerPage|null $value: The value for the itemsPerPage property. Use nul to unset.

setStartIndex (line 214)

Set the start index property for feed paging.

- return: Provides a fluent interface.

Zend_Gdata_Feed setStartIndex (Zend_Gdata_Extension_OpenSearchStartIndex|null $value)

- Zend_Gdata_Extension_OpenSearchStartIndex|null $value: The value for the startIndex property. Use null to unset.

setTotalResults (line 192)

Set the value of the totalResults property.

- return: Provides a fluent interface.

Zend_Gdata_Feed setTotalResults (Zend_Gdata_Extension_OpenSearchTotalResults|null $value)

- Zend_Gdata_Extension_OpenSearchTotalResults|null $value: The value of the totalResults property. Use null to unset.

takeAttributeFromDOM (line 164)

Given a DOMNode representing an attribute, tries to map the data into instance members. If no mapping is defined, the name and value are stored in an array.

- access: protected

void takeAttributeFromDOM (DOMNode $attribute)

- DOMNode $attribute: The DOMNode attribute needed to be handled

Redefinition of:

Zend_Gdata_App_Base::takeAttributeFromDOM()
  Given a DOMNode representing an attribute, tries to map the data into instance members. If no mapping is defined, the name and value are stored in an array.

takeChildFromDOM (line 132)

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_Feed::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_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()

#### Inherited Methods

Inherited From Zend_Gdata_App_Feed

> Zend_Gdata_App_Feed::addEntry()
> Zend_Gdata_App_Feed::count()
> Zend_Gdata_App_Feed::current()
> Zend_Gdata_App_Feed::getDOM()
> Zend_Gdata_App_Feed::getEntry()
> Zend_Gdata_App_Feed::getNextFeed()
> Zend_Gdata_App_Feed::getPreviousFeed()
> Zend_Gdata_App_Feed::key()
> Zend_Gdata_App_Feed::next()
> Zend_Gdata_App_Feed::offsetExists()
> Zend_Gdata_App_Feed::offsetGet()
> Zend_Gdata_App_Feed::offsetSet()
> Zend_Gdata_App_Feed::offsetUnset()
> Zend_Gdata_App_Feed::rewind()
> Zend_Gdata_App_Feed::setEntry()
> Zend_Gdata_App_Feed::setMajorProtocolVersion()
> Zend_Gdata_App_Feed::setMinorProtocolVersion()
> Zend_Gdata_App_Feed::takeChildFromDOM()
> Zend_Gdata_App_Feed::valid()
> Zend_Gdata_App_Feed::__get()

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:42 +0400 by phpDocumentor 1.4.2