Gdata/Feed.php

Show: PublicProtectedPrivateinherited
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 [email protected] so we can send you a copy immediately.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Gdata  
Subpackage
Gdata  
Version
$Id$  

\Zend_Gdata_Feed

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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedstring $_entryClassName = 'Zend_Gdata_Entry'
The classname for individual feed elements.
Default value'Zend_Gdata_Entry'Details
Type
string
>VPropertyprotected\Zend_Gdata_Extension_OpenSearchItemsPerPage|null $_itemsPerPage = null
The openSearch:itemsPerPage element
Default valuenullDetails
Type
\Zend_Gdata_Extension_OpenSearchItemsPerPage | null
>VPropertyprotected\Zend_Gdata_Extension_OpenSearchStartIndex|null $_startIndex = null
The openSearch:startIndex element
Default valuenullDetails
Type
\Zend_Gdata_Extension_OpenSearchStartIndex | null
>VPropertyprotected\Zend_Gdata_Extension_OpenSearchTotalResults|null $_totalResults = null
The openSearch:totalResults element
Default valuenullDetails
Type
\Zend_Gdata_Extension_OpenSearchTotalResults | null

Methods

methodpublic__construct( $element = null) : void

Parameters
NameTypeDescription
$element
methodpublicgetDOM( $doc = null,  $majorVersion = 1,  $minorVersion = null) : void

Parameters
NameTypeDescription
$doc
$majorVersion
$minorVersion
methodpublicgetItemsPerPage() : \Zend_Gdata_Extension_OpenSearchItemsPerPage | null

Get the value of the itemsPerPage property.

Returns
TypeDescription
\Zend_Gdata_Extension_OpenSearchItemsPerPage | nullThe value of the itemsPerPage property, or null if unset.
methodpublicgetStartIndex() : \Zend_Gdata_Extension_OpenSearchStartIndex | null

Get the value of the startIndex property.

Returns
TypeDescription
\Zend_Gdata_Extension_OpenSearchStartIndex | nullThe value of the startIndex property, or null if unset.
methodpublicgetTotalResults() : \Zend_Gdata_Extension_OpenSearchTotalResults | null

Get the value of the totalResults property.

Returns
TypeDescription
\Zend_Gdata_Extension_OpenSearchTotalResults | nullThe value of the totalResults property, or null if unset.
methodpublicsetItemsPerPage(\Zend_Gdata_Extension_OpenSearchItemsPerPage | null $value) : \Zend_Gdata_Feed

Set the itemsPerPage property.

Parameters
NameTypeDescription
$value\Zend_Gdata_Extension_OpenSearchItemsPerPage | null

The value for the itemsPerPage property. Use nul to unset.

Returns
TypeDescription
\Zend_Gdata_FeedProvides a fluent interface.
methodpublicsetStartIndex(\Zend_Gdata_Extension_OpenSearchStartIndex | null $value) : \Zend_Gdata_Feed

Set the start index property for feed paging.

Parameters
NameTypeDescription
$value\Zend_Gdata_Extension_OpenSearchStartIndex | null

The value for the startIndex property. Use null to unset.

Returns
TypeDescription
\Zend_Gdata_FeedProvides a fluent interface.
methodpublicsetTotalResults(\Zend_Gdata_Extension_OpenSearchTotalResults | null $value) : \Zend_Gdata_Feed

Set the value of the totalResults property.

Parameters
NameTypeDescription
$value\Zend_Gdata_Extension_OpenSearchTotalResults | null

The value of the totalResults property. Use null to unset.

Returns
TypeDescription
\Zend_Gdata_FeedProvides a fluent interface.
methodprotectedtakeAttributeFromDOM(\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
NameTypeDescription
$attribute\DOMNode

The DOMNode attribute needed to be handled

methodprotectedtakeChildFromDOM(\DOMNode $child) : void

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

Parameters
NameTypeDescription
$child\DOMNode

The DOMNode to process

Documentation was generated by phpDocumentor 2.2.0 .