[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/zend/Zend/Gdata/App/ -> Feed.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
Version: $Id$
File Size: 352 lines (10 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Zend_Gdata_App_Feed:: (20 methods):
  __get()
  getDOM()
  takeChildFromDOM()
  count()
  rewind()
  current()
  key()
  next()
  valid()
  getEntry()
  setEntry()
  addEntry()
  offsetSet()
  offsetGet()
  offsetUnset()
  offsetExists()
  getNextFeed()
  getPreviousFeed()
  setMajorProtocolVersion()
  setMinorProtocolVersion()


Class: Zend_Gdata_App_Feed  - X-Ref

Atom feed class

__get($var)   X-Ref
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).

param: string $var The property to get.
return: mixed

getDOM($doc = null, $majorVersion = 1, $minorVersion = null)   X-Ref
Retrieves the DOM model representing this object and all children

param: DOMDocument $doc
return: DOMElement

takeChildFromDOM($child)   X-Ref
Creates individual Entry objects of the appropriate type and
stores them in the $_entry array based upon DOM data.

param: DOMNode $child The DOMNode to process

count()   X-Ref
Get the number of entries in this feed object.

return: integer Entry count.

rewind()   X-Ref
Required by the Iterator interface.

return: void

current()   X-Ref
Required by the Iterator interface.

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

key()   X-Ref
Required by the Iterator interface.

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

next()   X-Ref
Required by the Iterator interface.

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

valid()   X-Ref
Required by the Iterator interface.

return: boolean Whether the iteration is valid

getEntry()   X-Ref
Gets the array of atom:entry elements contained within this
atom:feed representation

return: array Zend_Gdata_App_Entry array

setEntry($value)   X-Ref
Sets the array of atom:entry elements contained within this
atom:feed representation

param: array $value The array of Zend_Gdata_App_Entry elements
return: Zend_Gdata_App_Feed Provides a fluent interface

addEntry($value)   X-Ref
Adds an entry representation to the array of entries
contained within this feed

param: Zend_Gdata_App_Entry An individual entry to add.
return: Zend_Gdata_App_Feed Provides a fluent interface

offsetSet($key, $value)   X-Ref
Required by the ArrayAccess interface

param: int $key The index to set
param: Zend_Gdata_App_Entry $value The value to set
return: void

offsetGet($key)   X-Ref
Required by the ArrayAccess interface

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

offsetUnset($key)   X-Ref
Required by the ArrayAccess interface

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

offsetExists($key)   X-Ref
Required by the ArrayAccess interface

param: int $key The index to check for existence
return: boolean

getNextFeed()   X-Ref
Retrieve the next set of results from this feed.

return: mixed|null Returns the next set of results as a feed of the same

getPreviousFeed()   X-Ref
Retrieve the previous set of results from this feed.

return: mixed|null Returns the previous set of results as a feed of

setMajorProtocolVersion($value)   X-Ref
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.

param: (int|NULL) $value The major protocol version to use.

setMinorProtocolVersion($value)   X-Ref
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.

param: (int|NULL) $value The minor protocol version to use.



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1