Zend/Gdata/App/Feed.php

Show:

inherited

Classes
- \Zend_Gdata_App_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: App
Version: $Id: Feed.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Gdata_App_Feed
jump to top

Package: Zend\Gdata\App

Atom feed class

Implements
Parent(s): \Zend_Gdata_App_FeedSourceParent < \Zend_Gdata_App_FeedEntryParent < \Zend_Gdata_App_Base
Children: \Zend_Gdata_Feed
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

array
                 $_entry= 'array()'

Cache of feed entries.

Default valuearray()Details

Type: array

int
                 $_entryIndex= '0'

Current location in $_entry array

Default value0Details

Type: int

string
                 $_rootElement= ''feed''

The root xml element of this data element

Default value'feed'Details

Type: string

Methods

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

Parameters

Name	Type	Description
$var	string	The property to get.

Returns

Type	Description
mixed

addEntry(
          \Zend_Gdata_App_Entry $value
          )
        
        :
          \Zend_Gdata_App_Feed

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

Parameters

Name	Type	Description
$value	\Zend_Gdata_App_Entry	An individual entry to add.

Returns

Type	Description
\Zend_Gdata_App_Feed	Provides a fluent interface

count(
          
          )
        
        :
          integer

Get the number of entries in this feed object.

Returns

Type	Description
integer	Entry count.

current(
          
          )
        
        :
          mixed

Required by the Iterator interface.

Returns

Type	Description
mixed	The current row, or null if no rows.

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

Retrieves the DOM model representing this object and all children

Parameters

Name	Type	Description
$doc	\DOMDocument
$majorVersion
$minorVersion

Returns

Type	Description
\DOMElement

getEntry(
          
          )
        
        :
          array

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

Returns

Type	Description
array	Zend_Gdata_App_Entry array

getNextFeed(
          
          )
        
        :
          mixed|null

Retrieve the next set of results from this feed.

Returns

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

Throws

Exception	Description
\Zend_Gdata_App_Exception

getPreviousFeed(
          
          )
        
        :
          mixed|null

Retrieve the previous set of results from this feed.

Returns

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

Throws

Exception	Description
\Zend_Gdata_App_Exception

Required by the Iterator interface.

Returns

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

Required by the Iterator interface.

Returns

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

offsetExists(
          int $key
          )
        
        :
          boolean

Required by the ArrayAccess interface

Parameters

Name	Type	Description
$key	int	The index to check for existence

Returns

Type	Description
boolean

offsetGet(
          int $key
          )
        
        :
          void

Required by the ArrayAccess interface

Parameters

Name	Type	Description
$key	int	The index to get

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

Required by the ArrayAccess interface

Parameters

Name	Type	Description
$key	int	The index to set
$value	\Zend_Gdata_App_Entry	The value to set

offsetUnset(
          int $key
          )
        
        :
          void

Required by the ArrayAccess interface

Parameters

Name	Type	Description
$key	int	The index to set

rewind(
          
          )
        
        :
          void

Required by the Iterator interface.

setEntry(
          array $value
          )
        
        :
          \Zend_Gdata_App_Feed

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

Parameters

Name	Type	Description
$value	array	The array of Zend_Gdata_App_Entry elements

Returns

Type	Description
\Zend_Gdata_App_Feed	Provides a fluent interface

setMajorProtocolVersion(
          \(int|\NULL) $value
          )
        
        :
          void

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.

Parameters

Name	Type	Description
$value	\(int\|\NULL)	The major protocol version to use.

Throws

Exception	Description
\Zend_Gdata_App_InvalidArgumentException

Details

See: \_majorProtocolVersion

setMinorProtocolVersion(
          \(int|\NULL) $value
          )
        
        :
          void

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.

Parameters

Name	Type	Description
$value	\(int\|\NULL)	The minor protocol version to use.

Throws

Exception	Description
\Zend_Gdata_App_InvalidArgumentException

Details

See: \_minorProtocolVersion

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

valid(
          
          )
        
        :
          boolean

Required by the Iterator interface.

Returns

Type	Description
boolean	Whether the iteration is valid

API Documentation

Zend/Gdata/App/Feed.php

\Zend_Gdata_App_Feedjump to top

Properties

Methods

\Zend_Gdata_App_Feed
jump to top