Zend/Gdata/Feed.php

Show:

inherited

Classes
- \Zend_Gdata_Feed

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_Gdata
Subpackage: Gdata
Version: $Id: Feed.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Gdata_Feed
jump to top

Package: Zend\Gdata\Gdata

The Gdata flavor of an Atom Feed

Parent(s): \Zend_Gdata_App_Feed < \Zend_Gdata_App_FeedSourceParent < \Zend_Gdata_App_FeedEntryParent < \Zend_Gdata_App_Base
Children: \Zend_Gdata_Calendar_EventFeed; \Zend_Gdata_Calendar_ListFeed; \Zend_Gdata_Books_CollectionFeed; \Zend_Gdata_Books_VolumeFeed; \Zend_Gdata_Gbase_ItemFeed; \Zend_Gdata_Gbase_Feed; \Zend_Gdata_Gbase_SnippetFeed; \Zend_Gdata_Health_ProfileListFeed; \Zend_Gdata_Health_ProfileFeed; \Zend_Gdata_YouTube_ActivityFeed; \Zend_Gdata_YouTube_CommentFeed; \Zend_Gdata_Spreadsheets_SpreadsheetFeed; \Zend_Gdata_Spreadsheets_CellFeed; \Zend_Gdata_Spreadsheets_ListFeed; \Zend_Gdata_Spreadsheets_WorksheetFeed; \Zend_Gdata_Docs_DocumentListFeed; \Zend_Gdata_Geo_Feed; \Zend_Gdata_Analytics_DataFeed; \Zend_Gdata_Analytics_AccountFeed; \Zend_Gdata_Media_Feed; \Zend_Gdata_Gapps_EmailListFeed; \Zend_Gdata_Gapps_NicknameFeed; \Zend_Gdata_Gapps_EmailListRecipientFeed; \Zend_Gdata_Gapps_OwnerFeed; \Zend_Gdata_Gapps_GroupFeed; \Zend_Gdata_Gapps_UserFeed; \Zend_Gdata_Gapps_MemberFeed; \Zend_Gdata_Exif_Feed; \Zend_Gdata_Photos_AlbumFeed; \Zend_Gdata_Photos_PhotoFeed; \Zend_Gdata_Photos_UserFeed
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

string
                 $_entryClassName= ''Zend_Gdata_Entry''

The classname for individual feed elements.

Default value'Zend_Gdata_Entry'Details

Type: string

\Zend_Gdata_Extension_OpenSearchItemsPerPage|null
                 $_itemsPerPage= 'null'

The openSearch:itemsPerPage element

Default valuenullDetails

Type: \Zend_Gdata_Extension_OpenSearchItemsPerPagenull

\Zend_Gdata_Extension_OpenSearchStartIndex|null
                 $_startIndex= 'null'

The openSearch:startIndex element

Default valuenullDetails

Type: \Zend_Gdata_Extension_OpenSearchStartIndexnull

\Zend_Gdata_Extension_OpenSearchTotalResults|null
                 $_totalResults= 'null'

The openSearch:totalResults element

Default valuenullDetails

Type: \Zend_Gdata_Extension_OpenSearchTotalResultsnull

Methods

__construct(
           $element
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$element

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

Parameters

Name	Type	Description
$doc
$majorVersion
$minorVersion

getItemsPerPage(
          
          )
        
        :
          \Zend_Gdata_Extension_OpenSearchItemsPerPage|null

Get the value of the itemsPerPage property.

Returns

Type	Description
\Zend_Gdata_Extension_OpenSearchItemsPerPage\|null	The value of the itemsPerPage property, or null if unset.

getStartIndex(
          
          )
        
        :
          \Zend_Gdata_Extension_OpenSearchStartIndex|null

Get the value of the startIndex property.

Returns

Type	Description
\Zend_Gdata_Extension_OpenSearchStartIndex\|null	The value of the startIndex property, or null if unset.

getTotalResults(
          
          )
        
        :
          \Zend_Gdata_Extension_OpenSearchTotalResults|null

Get the value of the totalResults property.

Returns

Type	Description
\Zend_Gdata_Extension_OpenSearchTotalResults\|null	The value of the totalResults property, or null if unset.

setItemsPerPage(
          \Zend_Gdata_Extension_OpenSearchItemsPerPage|null $value
          )
        
        :
          \Zend_Gdata_Feed

Set the itemsPerPage property.

Parameters

Name	Type	Description
$value	\Zend_Gdata_Extension_OpenSearchItemsPerPage\|null	The value for the itemsPerPage property. Use nul to unset.

Returns

Type	Description
\Zend_Gdata_Feed	Provides a fluent interface.

setStartIndex(
          \Zend_Gdata_Extension_OpenSearchStartIndex|null $value
          )
        
        :
          \Zend_Gdata_Feed

Set the start index property for feed paging.

Parameters

Name	Type	Description
$value	\Zend_Gdata_Extension_OpenSearchStartIndex\|null	The value for the startIndex property. Use null to unset.

Returns

Type	Description
\Zend_Gdata_Feed	Provides a fluent interface.

setTotalResults(
          \Zend_Gdata_Extension_OpenSearchTotalResults|null $value
          )
        
        :
          \Zend_Gdata_Feed

Set the value of the totalResults property.

Parameters

Name	Type	Description
$value	\Zend_Gdata_Extension_OpenSearchTotalResults\|null	The value of the totalResults property. Use null to unset.

Returns

Type	Description
\Zend_Gdata_Feed	Provides a fluent interface.

takeAttributeFromDOM(
          \DOMNode $attribute
          )
        
        :
          void

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.

Parameters

Name	Type	Description
$attribute	\DOMNode	The DOMNode attribute needed to be handled

takeChildFromDOM(
          \DOMNode $child
          )
        
        :
          void

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

Parameters

Name	Type	Description
$child	\DOMNode	The DOMNode to process

API Documentation

Zend/Gdata/Feed.php

\Zend_Gdata_Feedjump to top

Properties

Methods

\Zend_Gdata_Feed
jump to top