Gdata/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_Gdata
subpackage: Gdata
version: $Id: Feed.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Gdata_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_Gdata_Feed
jump to top

Extends from: Zend_Gdata_App_Feed
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_Gdata
subpackage: Gdata
Properties: $_entryClassName; $_totalResults; $_startIndex; $_itemsPerPage
Methods: __construct; getDOM; takeChildFromDOM; takeAttributeFromDOM; setTotalResults; getTotalResults; setStartIndex; getStartIndex; setItemsPerPage; getItemsPerPage

Description

The Gdata flavor of an Atom Feed

Properties

$_entryClassName
jump to class

string $_entryClassName = 'Zend_Gdata_Entry'

The classname for individual feed elements.

Details

$_entryClassName: string
visibility: protected
default: Zend_Gdata_Entry
final: false
static: false

$_itemsPerPage
jump to class

Zend_Gdata_Extension_OpenSearchItemsPerPage|null $_itemsPerPage = 'null'

The openSearch:itemsPerPage element

Details

$_itemsPerPage: Zend_Gdata_Extension_OpenSearchItemsPerPage|null
visibility: protected
default: null
final: false
static: false

$_startIndex
jump to class

Zend_Gdata_Extension_OpenSearchStartIndex|null $_startIndex = 'null'

The openSearch:startIndex element

Details

$_startIndex: Zend_Gdata_Extension_OpenSearchStartIndex|null
visibility: protected
default: null
final: false
static: false

$_totalResults
jump to class

Zend_Gdata_Extension_OpenSearchTotalResults|null $_totalResults = 'null'

The openSearch:totalResults element

Details

$_totalResults: Zend_Gdata_Extension_OpenSearchTotalResults|null
visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

__construct(
           $element
              =
              null
          )
        
        :

Arguments

$element

Details

visibility: public
final: false
static: false

getDOM
jump to class

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

Arguments

$doc
$majorVersion
$minorVersion

Details

visibility: public
final: false
static: false

getItemsPerPage
jump to class

getItemsPerPage(
          
          )
        
        :
        Zend_Gdata_Extension_OpenSearchItemsPerPage|null

Get the value of the itemsPerPage property.

Output

Zend_Gdata_Extension_OpenSearchItemsPerPage|null: The value of the itemsPerPage property, or null if unset.

Details

visibility: public
final: false
static: false

getStartIndex
jump to class

getStartIndex(
          
          )
        
        :
        Zend_Gdata_Extension_OpenSearchStartIndex|null

Get the value of the startIndex property.

Output

Zend_Gdata_Extension_OpenSearchStartIndex|null: The value of the startIndex property, or null if unset.

Details

visibility: public
final: false
static: false

getTotalResults
jump to class

getTotalResults(
          
          )
        
        :
        Zend_Gdata_Extension_OpenSearchTotalResults|null

Get the value of the totalResults property.

Output

Zend_Gdata_Extension_OpenSearchTotalResults|null: The value of the totalResults property, or null if unset.

Details

visibility: public
final: false
static: false

setItemsPerPage
jump to class

setItemsPerPage(
          Zend_Gdata_Extension_OpenSearchItemsPerPage|null $value
          )
        
        :
        Zend_Gdata_Feed

Set the itemsPerPage property.

Arguments

$value: Zend_Gdata_Extension_OpenSearchItemsPerPagenull
The value for the itemsPerPage property. Use nul to unset.

Output

Zend_Gdata_Feed: Provides a fluent interface.

Details

visibility: public
final: false
static: false

setStartIndex
jump to class

setStartIndex(
          Zend_Gdata_Extension_OpenSearchStartIndex|null $value
          )
        
        :
        Zend_Gdata_Feed

Set the start index property for feed paging.

Arguments

$value: Zend_Gdata_Extension_OpenSearchStartIndexnull
The value for the startIndex property. Use null to unset.

Output

Zend_Gdata_Feed: Provides a fluent interface.

Details

visibility: public
final: false
static: false

setTotalResults
jump to class

setTotalResults(
          Zend_Gdata_Extension_OpenSearchTotalResults|null $value
          )
        
        :
        Zend_Gdata_Feed

Set the value of the totalResults property.

Arguments

$value: Zend_Gdata_Extension_OpenSearchTotalResultsnull
The value of the totalResults property. Use null to unset.

Output

Zend_Gdata_Feed: Provides a fluent interface.

Details

visibility: public
final: false
static: false

takeAttributeFromDOM
jump to class

takeAttributeFromDOM(
          DOMNode $attribute
          )
        
        :

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.

Arguments

$attribute: DOMNode
The DOMNode attribute needed to be handled

Details

visibility: protected
final: false
static: false

takeChildFromDOM
jump to class

takeChildFromDOM(
          DOMNode $child
          )
        
        :

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

Arguments

$child: DOMNode
The DOMNode to process

Details

visibility: protected
final: false
static: false

API Documentation

Gdata/Feed.php

Description

Zend_Gdata_Feedjump to top

Description

Properties

$_entryClassNamejump to class

Details

$_itemsPerPagejump to class

Details

$_startIndexjump to class

Details

$_totalResultsjump to class

Details

Methods

__constructjump to class

Arguments

Details

getDOMjump to class

Arguments

Details

getItemsPerPagejump to class

Output

Details

getStartIndexjump to class

Output

Details

getTotalResultsjump to class

Output

Details

setItemsPerPagejump to class

Arguments

Output

Details

setStartIndexjump to class

Arguments

Output

Details

setTotalResultsjump to class

Arguments

Output

Details

takeAttributeFromDOMjump to class

Arguments

Details

takeChildFromDOMjump to class

Arguments

Details

Zend_Gdata_Feed
jump to top

$_entryClassName
jump to class

$_itemsPerPage
jump to class

$_startIndex
jump to class

$_totalResults
jump to class

__construct
jump to class

getDOM
jump to class

getItemsPerPage
jump to class

getStartIndex
jump to class

getTotalResults
jump to class

setItemsPerPage
jump to class

setStartIndex
jump to class

setTotalResults
jump to class

takeAttributeFromDOM
jump to class

takeChildFromDOM
jump to class