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

Extends from: Zend_Gdata_App_FeedSourceParent
Implements
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: App
Properties: $_rootElement; $_entry; $_entryIndex
Methods: __get; getDOM; takeChildFromDOM; count; rewind; current; key; next; valid; getEntry; setEntry; addEntry; offsetSet; offsetGet; offsetUnset; offsetExists; getNextFeed; getPreviousFeed; setMajorProtocolVersion; setMinorProtocolVersion

Description

Atom feed class

Properties

$_entry
jump to class

array $_entry = 'array'

Cache of feed entries.

Details

$_entry: array
visibility: protected
default: array
final: false
static: false

$_entryIndex
jump to class

int $_entryIndex = '0'

Current location in $_entry array

Details

$_entryIndex: int
visibility: protected
default: 0
final: false
static: false

$_rootElement
jump to class

string $_rootElement = 'feed'

The root xml element of this data element

Details

$_rootElement: string
visibility: protected
default: feed
final: false
static: false

Methods

__get
jump to class

__get(
          string $var
          )
        
        :
        mixed

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

Arguments

$var: string
The property to get.

Output

mixed

Details

visibility: public
final: false
static: false

addEntry
jump to class

addEntry(
          Zend_Gdata_App_Entry $value
          )
        
        :
        Zend_Gdata_App_Feed

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

Arguments

$value: Zend_Gdata_App_Entry
An individual entry to add.

Output

Zend_Gdata_App_Feed: Provides a fluent interface

Details

visibility: public
final: false
static: false

count
jump to class

count(
          
          )
        
        :
        integer

Get the number of entries in this feed object.

Output

integer: Entry count.

Details

visibility: public
final: false
static: false

current
jump to class

current(
          
          )
        
        :
        mixed

Required by the Iterator interface.

Output

mixed: The current row, or null if no rows.

Details

visibility: public
final: false
static: false

getDOM
jump to class

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

Retrieves the DOM model representing this object and all children

Arguments

$doc: DOMDocument
$majorVersion
$minorVersion

Output

DOMElement

Details

visibility: public
final: false
static: false

getEntry
jump to class

getEntry(
          
          )
        
        :
        array

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

Output

array: Zend_Gdata_App_Entry array

Details

visibility: public
final: false
static: false

getNextFeed
jump to class

getNextFeed(
          
          )
        
        :
        mixed|null

Retrieve the next set of results from this feed.

Output

mixed|null: Returns the next set of results as a feed of the same class as this feed, or null if no results exist.

Details

visibility: public
final: false
static: false
throws

getPreviousFeed
jump to class

getPreviousFeed(
          
          )
        
        :
        mixed|null

Retrieve the previous set of results from this feed.

Output

mixed|null: Returns the previous set of results as a feed of the same class as this feed, or null if no results exist.

Details

visibility: public
final: false
static: false
throws

key
jump to class

Required by the Iterator interface.

Output

mixed: The current row number (starts at 0), or NULL if no rows

Details

visibility: public
final: false
static: false

next
jump to class

Required by the Iterator interface.

Output

mixed: The next row, or null if no more rows.

Details

visibility: public
final: false
static: false

offsetExists
jump to class

offsetExists(
          int $key
          )
        
        :
        boolean

Required by the ArrayAccess interface

Arguments

$key: int
The index to check for existence

Output

boolean

Details

visibility: public
final: false
static: false

offsetGet
jump to class

offsetGet(
          int $key
          )
        
        :

Required by the ArrayAccess interface

Arguments

$key: int
The index to get

Details

visibility: public
final: false
static: false

offsetSet
jump to class

offsetSet(
          int $key, Zend_Gdata_App_Entry $value
          )
        
        :
        void

Required by the ArrayAccess interface

Arguments

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

Details

visibility: public
final: false
static: false

offsetUnset
jump to class

offsetUnset(
          int $key
          )
        
        :

Required by the ArrayAccess interface

Arguments

$key: int
The index to set

Details

visibility: public
final: false
static: false

rewind
jump to class

rewind(
          
          )
        
        :
        void

Required by the Iterator interface.

Details

visibility: public
final: false
static: false

setEntry
jump to class

setEntry(
          array $value
          )
        
        :
        Zend_Gdata_App_Feed

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

Arguments

$value: array
The array of Zend_Gdata_App_Entry elements

Output

Zend_Gdata_App_Feed: Provides a fluent interface

Details

visibility: public
final: false
static: false

setMajorProtocolVersion
jump to class

setMajorProtocolVersion(
          (int|NULL) $value
          )
        
        :

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.

Arguments

$value: (intNULL)
The major protocol version to use.

Details

visibility: public
final: false
static: false
see: _majorProtocolVersion
throws

setMinorProtocolVersion
jump to class

setMinorProtocolVersion(
          (int|NULL) $value
          )
        
        :

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.

Arguments

$value: (intNULL)
The minor protocol version to use.

Details

visibility: public
final: false
static: false
see: _minorProtocolVersion
throws

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

valid
jump to class

valid(
          
          )
        
        :
        boolean

Required by the Iterator interface.

Output

boolean: Whether the iteration is valid

Details

visibility: public
final: false
static: false

API Documentation

Gdata/App/Feed.php

Description

Zend_Gdata_App_Feedjump to top

Description

Properties

$_entryjump to class

Details

$_entryIndexjump to class

Details

$_rootElementjump to class

Details

Methods

__getjump to class

Arguments

Output

Details

addEntryjump to class

Arguments

Output

Details

countjump to class

Output

Details

currentjump to class

Output

Details

getDOMjump to class

Arguments

Output

Details

getEntryjump to class

Output

Details

getNextFeedjump to class

Output

Details

getPreviousFeedjump to class

Output

Details

keyjump to class

Output

Details

nextjump to class

Output

Details

offsetExistsjump to class

Arguments

Output

Details

offsetGetjump to class

Arguments

Details

offsetSetjump to class

Arguments

Details

offsetUnsetjump to class

Arguments

Details

rewindjump to class

Details

setEntryjump to class

Arguments

Output

Details

setMajorProtocolVersionjump to class

Arguments

Details

setMinorProtocolVersionjump to class

Arguments

Details

takeChildFromDOMjump to class

Arguments

Details

validjump to class

Output

Details

Zend_Gdata_App_Feed
jump to top

$_entry
jump to class

$_entryIndex
jump to class

$_rootElement
jump to class

__get
jump to class

addEntry
jump to class

count
jump to class

current
jump to class

getDOM
jump to class

getEntry
jump to class

getNextFeed
jump to class

getPreviousFeed
jump to class

key
jump to class

next
jump to class

offsetExists
jump to class

offsetGet
jump to class

offsetSet
jump to class

offsetUnset
jump to class

rewind
jump to class

setEntry
jump to class

setMajorProtocolVersion
jump to class

setMinorProtocolVersion
jump to class

takeChildFromDOM
jump to class

valid
jump to class