Zend Framework  1.12
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_Gdata_App_Feed Class Reference

Public Member Functions

 __get ($var)
 Make accessing some individual elements of the feed easier.
 
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 Retrieves the DOM model representing this object and all children.
 
 count ()
 Get the number of entries in this feed object.
 
 rewind ()
 Required by the Iterator interface.
 
 current ()
 Required by the Iterator interface.
 
 key ()
 Required by the Iterator interface.
 
 next ()
 Required by the Iterator interface.
 
 valid ()
 Required by the Iterator interface.
 
 getEntry ()
 Gets the array of atom:entry elements contained within this atom:feed representation.
 
 setEntry ($value)
 Sets the array of atom:entry elements contained within this atom:feed representation.
 
 addEntry ($value)
 Adds an entry representation to the array of entries contained within this feed.
 
 offsetSet ($key, $value)
 Required by the ArrayAccess interface.
 
 offsetGet ($key)
 Required by the ArrayAccess interface.
 
 offsetUnset ($key)
 Required by the ArrayAccess interface.
 
 offsetExists ($key)
 Required by the ArrayAccess interface.
 
 getNextFeed ()
 Retrieve the next set of results from this feed.
 
 getPreviousFeed ()
 Retrieve the previous set of results from this feed.
 
 setMajorProtocolVersion ($value)
 Set the major protocol version that should be used.
 
 setMinorProtocolVersion ($value)
 Set the minor protocol version that should be used.
 
- Public Member Functions inherited from Zend_Gdata_App_FeedSourceParent
 setHttpClient (Zend_Http_Client $httpClient)
 Set the HTTP client instance.
 
 setService ($instance)
 Set the active service instance for this feed and all enclosed entries.
 
 __get ($var)
 Make accessing some individual elements of the feed easier.
 
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 
 getGenerator ()
 
 setGenerator ($value)
 
 getIcon ()
 
 setIcon ($value)
 
 getlogo ()
 
 setlogo ($value)
 
 getSubtitle ()
 
 setSubtitle ($value)
 
- Public Member Functions inherited from Zend_Gdata_App_FeedEntryParent
 __construct ($element=null)
 Constructs a Feed or Entry.
 
 setHttpClient (Zend_Http_Client $httpClient)
 Set the HTTP client instance.
 
 getHttpClient ()
 Gets the HTTP client object.
 
 setService ($instance)
 Set the active service instance for this object.
 
 getService ()
 Get the active service instance for this object.
 
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 
 getAuthor ()
 
 setAuthor ($value)
 Sets the list of the authors of this feed/entry.
 
 getCategory ()
 Returns the array of categories that classify this feed/entry.
 
 setCategory ($value)
 Sets the array of categories that classify this feed/entry.
 
 getContributor ()
 Returns the array of contributors to this feed/entry.
 
 setContributor ($value)
 Sets the array of contributors to this feed/entry.
 
 getId ()
 
 setId ($value)
 
 getLink ($rel=null)
 Given a particular 'rel' value, this method returns a matching Zend_Gdata_App_Extension_Link element.
 
 getEditLink ()
 Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to edit this resource.
 
 getNextLink ()
 Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to retrieve the next chunk of results when paging through a feed.
 
 getPreviousLink ()
 Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to retrieve the previous chunk of results when paging through a feed.
 
 getLicenseLink ()
 
 getSelfLink ()
 Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to retrieve the entry or feed represented by this object This link is in the atom feed/entry as an atom:link with a rel attribute value of 'self'.
 
 getAlternateLink ()
 Returns the Zend_Gdata_App_Extension_Link element which represents the URL for an alternate view of the data represented by this feed or entry.
 
 setLink ($value)
 
 getRights ()
 
 setRights ($value)
 
 getTitle ()
 Returns the title of this feed or entry.
 
 getTitleValue ()
 Returns a string representation of the title of this feed or entry.
 
 setTitle ($value)
 Returns the title of this feed or entry.
 
 getUpdated ()
 
 setUpdated ($value)
 
 setEtag ($value)
 Set the Etag for the current entry to $value.
 
 getEtag ()
 Return the Etag for the current entry, or null if not set.
 
 setMajorProtocolVersion ($value)
 Set the major protocol version that should be used.
 
 getMajorProtocolVersion ()
 Get the major protocol version that is in use.
 
 setMinorProtocolVersion ($value)
 Set the minor protocol version that should be used.
 
 getMinorProtocolVersion ()
 Get the minor protocol version that is in use.
 
 lookupNamespace ($prefix, $majorVersion=null, $minorVersion=null)
 Get the full version of a namespace prefix.
 
- Public Member Functions inherited from Zend_Gdata_App_Base
 __construct ()
 
 getText ($trim=true)
 Returns the child text node of this element This represents any raw text contained within the XML element.
 
 setText ($value)
 Sets the child text node of this element This represents any raw text contained within the XML element.
 
 getExtensionElements ()
 Returns an array of all elements not matched to data model classes during the parsing of the XML.
 
 setExtensionElements ($value)
 Sets an array of all elements not matched to data model classes during the parsing of the XML.
 
 getExtensionAttributes ()
 Returns an array of all extension attributes not transformed into data model properties during parsing of the XML.
 
 setExtensionAttributes ($value)
 Sets an array of all extension attributes not transformed into data model properties during parsing of the XML.
 
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 Retrieves a DOMElement which corresponds to this element and all child properties.
 
 transferFromDOM ($node)
 Transfers each child and attribute into member variables.
 
 transferFromXML ($xml)
 Parses the provided XML text and generates data model classes for each know element by turning the XML text into a DOM tree and calling transferFromDOM($element).
 
 saveXML ()
 Converts this element and all children into XML text using getDOM()
 
 getXML ()
 Alias for saveXML() returns XML content for this element and all children.
 
 encode ()
 Alias for saveXML()
 
 lookupNamespace ($prefix, $majorVersion=1, $minorVersion=null)
 Get the full version of a namespace prefix.
 
 registerNamespace ($prefix, $namespaceUri, $majorVersion=1, $minorVersion=0)
 Add a namespace and prefix to the registered list.
 
 registerAllNamespaces ($namespaceArray)
 Add an array of namespaces to the registered list.
 
 __get ($name)
 Magic getter to allow access like $entry->foo to call $entry->getFoo() Alternatively, if no getFoo() is defined, but a $_foo protected variable is defined, this is returned.
 
 __set ($name, $val)
 Magic setter to allow acces like $entry->foo='bar' to call $entry->setFoo('bar') automatically.
 
 __isset ($name)
 Magic __isset method.
 
 __unset ($name)
 Magic __unset method.
 
 __toString ()
 Magic toString method allows using this directly via echo Works best in PHP >= 4.2.0.
 

Protected Member Functions

 takeChildFromDOM ($child)
 Creates individual Entry objects of the appropriate type and stores them in the $_entry array based upon DOM data.
 
- Protected Member Functions inherited from Zend_Gdata_App_FeedSourceParent
 takeChildFromDOM ($child)
 Creates individual Entry objects of the appropriate type and stores them in the $_entry array based upon DOM data.
 
- Protected Member Functions inherited from Zend_Gdata_App_FeedEntryParent
 takeChildFromDOM ($child)
 
- Protected Member Functions inherited from Zend_Gdata_App_Base
 takeChildFromDOM ($child)
 Given a child DOMNode, tries to determine how to map the data into object instance members.
 
 takeAttributeFromDOM ($attribute)
 Given a DOMNode representing an attribute, tries to map the data into instance members.
 

Protected Attributes

 $_rootElement = 'feed'
 
 $_entry = array()
 
 $_entryIndex = 0
 
- Protected Attributes inherited from Zend_Gdata_App_FeedSourceParent
 $_entryClassName = 'Zend_Gdata_App_Entry'
 
 $_rootElement = null
 
 $_generator = null
 
 $_icon = null
 
 $_logo = null
 
 $_subtitle = null
 
- Protected Attributes inherited from Zend_Gdata_App_FeedEntryParent
 $_service = null
 Service instance used to make network requests.
 
 $_etag = NULL
 
 $_author = array()
 
 $_category = array()
 
 $_contributor = array()
 
 $_id = null
 
 $_link = array()
 
 $_rights = null
 
 $_title = null
 
 $_updated = null
 
 $_majorProtocolVersion = 1
 Indicates the major protocol version that should be used.
 
 $_minorProtocolVersion = null
 Indicates the minor protocol version that should be used.
 
- Protected Attributes inherited from Zend_Gdata_App_Base
 $_rootElement = null
 
 $_rootNamespace = 'atom'
 
 $_rootNamespaceURI = null
 
 $_extensionElements = array()
 
 $_extensionAttributes = array()
 
 $_text = null
 
 $_namespaces
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Gdata_App_Base
static flushNamespaceLookupCache ()
 Flush namespace lookup cache.
 
- Static Protected Attributes inherited from Zend_Gdata_App_Base
static $_namespaceLookupCache = array()
 

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
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
count ( )

Get the number of entries in this feed object.

Returns
integer Entry count.
current ( )

Required by the Iterator interface.

Returns
mixed The current row, or null if no rows.
getDOM (   $doc = null,
  $majorVersion = 1,
  $minorVersion = null 
)

Retrieves the DOM model representing this object and all children.

Parameters
DOMDocument$doc
Returns
DOMElement
getEntry ( )

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

Returns
array Zend_Gdata_App_Entry array
getNextFeed ( )

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

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

Required by the Iterator interface.

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

Required by the Iterator interface.

Returns
mixed The next row, or null if no more rows.
offsetExists (   $key)

Required by the ArrayAccess interface.

Parameters
int$keyThe index to check for existence
Returns
boolean
offsetGet (   $key)

Required by the ArrayAccess interface.

Parameters
int$keyThe index to get
Zend_Gdata_App_Entry$valueThe value to set
offsetSet (   $key,
  $value 
)

Required by the ArrayAccess interface.

Parameters
int$keyThe index to set
Zend_Gdata_App_Entry$valueThe value to set
Returns
void
offsetUnset (   $key)

Required by the ArrayAccess interface.

Parameters
int$keyThe index to set
Zend_Gdata_App_Entry$valueThe value to set
rewind ( )

Required by the Iterator interface.

Returns
void
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
setMajorProtocolVersion (   $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.

See Also
_majorProtocolVersion
Parameters
(int|NULL)$value The major protocol version to use.
Exceptions
Zend_Gdata_App_InvalidArgumentException
setMinorProtocolVersion (   $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.

See Also
_minorProtocolVersion
Parameters
(int|NULL)$value The minor protocol version to use.
Exceptions
Zend_Gdata_App_InvalidArgumentException
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
valid ( )

Required by the Iterator interface.

Returns
boolean Whether the iteration is valid

Member Data Documentation

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