Moodle  2.2.1
http://www.collinsharper.com
Zend_Gdata_App_Feed Class Reference
Inheritance diagram for Zend_Gdata_App_Feed:
Collaboration diagram for Zend_Gdata_App_Feed:

Public Member Functions

 __get ($var)
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 count ()
 rewind ()
 current ()
 key ()
 next ()
 valid ()
 getEntry ()
 setEntry ($value)
 addEntry ($value)
 offsetSet ($key, $value)
 offsetGet ($key)
 offsetUnset ($key)
 offsetExists ($key)
 getNextFeed ()
 getPreviousFeed ()
 setMajorProtocolVersion ($value)
 setMinorProtocolVersion ($value)

Protected Member Functions

 takeChildFromDOM ($child)

Protected Attributes

 $_rootElement = 'feed'
 $_entry = array()
 $_entryIndex = 0

Detailed Description

Definition at line 43 of file Feed.php.


Member Function Documentation

__get ( var)

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:
string$varThe property to get.
Returns:
mixed

Reimplemented from Zend_Gdata_App_FeedSourceParent.

Definition at line 79 of file Feed.php.

addEntry ( value)

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

Parameters:
Zend_Gdata_App_EntryAn individual entry to add.
Returns:
Zend_Gdata_App_Feed Provides a fluent interface

Definition at line 218 of file Feed.php.

count ( )

Get the number of entries in this feed object.

Returns:
integer Entry count.

Definition at line 132 of file Feed.php.

Here is the caller graph for this function:

current ( )

Required by the Iterator interface.

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

Definition at line 152 of file Feed.php.

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

Retrieves the DOM model representing this object and all children

Parameters:
DOMDocument$doc
Returns:
DOMElement

Reimplemented from Zend_Gdata_App_FeedSourceParent.

Reimplemented in Zend_Gdata_Photos_UserFeed, Zend_Gdata_Photos_PhotoFeed, Zend_Gdata_Photos_AlbumFeed, Zend_Gdata_Feed, Zend_Gdata_Spreadsheets_CellFeed, Zend_Gdata_Calendar_EventFeed, and Zend_Gdata_Calendar_ListFeed.

Definition at line 95 of file Feed.php.

getEntry ( )

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

Returns:
array Zend_Gdata_App_Entry array

Definition at line 193 of file Feed.php.

Retrieve the next set of results from this feed.

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

Definition at line 280 of file Feed.php.

Here is the call graph for this function:

Retrieve the previous set of results from this feed.

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

Definition at line 301 of file Feed.php.

Here is the call graph for this function:

key ( )

Required by the Iterator interface.

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

Definition at line 162 of file Feed.php.

next ( )

Required by the Iterator interface.

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

Definition at line 172 of file Feed.php.

offsetExists ( key)

Required by the ArrayAccess interface

Parameters:
int$keyThe index to check for existence
Returns:
boolean

Definition at line 268 of file Feed.php.

offsetGet ( key)

Required by the ArrayAccess interface

Parameters:
int$keyThe index to get
Zend_Gdata_App_Entry$valueThe value to set

Definition at line 242 of file Feed.php.

offsetSet ( key,
value 
)

Required by the ArrayAccess interface

Parameters:
int$keyThe index to set
Zend_Gdata_App_Entry$valueThe value to set
Returns:
void

Definition at line 231 of file Feed.php.

offsetUnset ( key)

Required by the ArrayAccess interface

Parameters:
int$keyThe index to set
Zend_Gdata_App_Entry$valueThe value to set

Definition at line 255 of file Feed.php.

rewind ( )

Required by the Iterator interface.

Returns:
void

Definition at line 142 of file Feed.php.

setEntry ( value)

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

Parameters:
array$valueThe array of Zend_Gdata_App_Entry elements
Returns:
Zend_Gdata_App_Feed Provides a fluent interface

Definition at line 205 of file Feed.php.

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.

See also:
_majorProtocolVersion
Parameters:
(int|NULL)$value The major protocol version to use.
Exceptions:
Zend_Gdata_App_InvalidArgumentException

Reimplemented from Zend_Gdata_App_FeedEntryParent.

Definition at line 325 of file Feed.php.

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.

See also:
_minorProtocolVersion
Parameters:
(int|NULL)$value The minor protocol version to use.
Exceptions:
Zend_Gdata_App_InvalidArgumentException

Reimplemented from Zend_Gdata_App_FeedEntryParent.

Definition at line 344 of file Feed.php.

takeChildFromDOM ( child) [protected]

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

Parameters:
DOMNode$childThe DOMNode to process

Reimplemented from Zend_Gdata_App_FeedSourceParent.

Reimplemented in Zend_Gdata_Photos_PhotoFeed, Zend_Gdata_Photos_AlbumFeed, Zend_Gdata_Feed, Zend_Gdata_Photos_UserFeed, Zend_Gdata_Spreadsheets_CellFeed, Zend_Gdata_Calendar_EventFeed, and Zend_Gdata_Calendar_ListFeed.

Definition at line 110 of file Feed.php.

Here is the call graph for this function:

valid ( )

Required by the Iterator interface.

Returns:
boolean Whether the iteration is valid

Definition at line 182 of file Feed.php.

Here is the call graph for this function:


Field Documentation

$_entry = array() [protected]

Definition at line 59 of file Feed.php.

$_entryIndex = 0 [protected]

Definition at line 66 of file Feed.php.

$_rootElement = 'feed' [protected]

Reimplemented from Zend_Gdata_App_FeedSourceParent.

Definition at line 52 of file Feed.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations