Public Member Functions
	__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)

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
	$_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()

Constructor & Destructor Documentation

__construct ( $element = null )

Constructs a Feed or Entry.

Member Function Documentation

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.

This alternate view is commonly a user-facing webpage, blog post, etc. The MIME type for the data at the URL is available from the returned Zend_Gdata_App_Extension_Link element. This link is in the atom feed/entry as an atom:link with a rel attribute value of 'self'.

Returns: Zend_Gdata_App_Extension_Link The link, or null if not found

getAuthor ( )

Returns: Zend_Gdata_App_Extension_Author

getCategory ( )

Returns the array of categories that classify this feed/entry.

Each category is represented in an atom feed by an atom:category element.

Returns: array Array of Zend_Gdata_App_Extension_Category

getContributor ( )

Returns the array of contributors to this feed/entry.

Each contributor is represented in an atom feed by an atom:contributor XML element

Returns: array An array of Zend_Gdata_App_Extension_Contributor

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

getEditLink ( )

Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to edit this resource.

This link is in the atom feed/entry as an atom:link with a rel attribute value of 'edit'.

Returns: Zend_Gdata_App_Extension_Link The link, or null if not found

getEtag ( )

Return the Etag for the current entry, or null if not set.

Returns: string|null

getHttpClient ( )

Gets the HTTP client object.

If none is set, a new Zend_Http_Client will be used.

Deprecated:: Deprecated as of Zend Framework 1.7. Use getService() instead.

Returns: Zend_Http_Client_Abstract

getId ( )

Returns: Zend_Gdata_App_Extension_Id

getLicenseLink ( )

Returns: Zend_Gdata_App_Extension_Link

getLink ( $rel = null )

Given a particular 'rel' value, this method returns a matching Zend_Gdata_App_Extension_Link element.

If the 'rel' value is not provided, the full array of Zend_Gdata_App_Extension_Link elements is returned. In an atom feed, each link is represented by an atom:link element. The 'rel' value passed to this function is the atom:link/ attribute. Example rel values include 'self', 'edit', and 'alternate'.

Parameters

string $rel The rel value of the link to be found. If null, the array of Zend_Gdata_App_Extension_link elements is returned

Returns: mixed Either a single Zend_Gdata_App_Extension_link element, an array of the same or null is returned depending on the rel value supplied as the argument to this function

getMajorProtocolVersion ( )

Get the major protocol version that is in use.

See Also: _majorProtocolVersion

Returns: (int|NULL) The major protocol version in use.

getMinorProtocolVersion ( )

Get the minor protocol version that is in use.

See Also: _minorProtocolVersion

Returns: (int|NULL) The major protocol version in use, or NULL if no minor version is specified.

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.

This link is in the atom feed as an atom:link with a rel attribute value of 'next'.

Returns: Zend_Gdata_App_Extension_Link The link, or null if not found

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.

This link is in the atom feed as an atom:link with a rel attribute value of 'previous'.

Returns: Zend_Gdata_App_Extension_Link The link, or null if not found

getRights ( )

Returns: Zend_Gdata_AppExtension_Rights

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

Returns: Zend_Gdata_App_Extension_Link The link, or null if not found

getService ( )

Get the active service instance for this object.

This will be used to perform network requests, such as when calling save() and delete().

Returns: Zend_Gdata_App|null The current service instance, or null if not set.

getTitle ( )

Returns the title of this feed or entry.

The title is an extremely short textual representation of this resource and is found as an atom:title element in a feed or entry

Returns: Zend_Gdata_App_Extension_Title

getTitleValue ( )

Returns a string representation of the title of this feed or entry.

The title is an extremely short textual representation of this resource and is found as an atom:title element in a feed or entry

Returns: string

getUpdated ( )

Returns: Zend_Gdata_App_Extension_Updated

lookupNamespace	(	$prefix,
		$majorVersion = `null`,
		$minorVersion = `null`
	)

Get the full version of a namespace prefix.

Looks up a prefix (atom:, etc.) in the list of registered namespaces and returns the full namespace URI if available. Returns the prefix, unmodified, if it's not registered.

The current entry or feed's version will be used when performing the namespace lookup unless overridden using $majorVersion and $minorVersion. If the entry/fee has a null version, then the latest protocol version will be used by default.

Parameters

string	$prefix	The namespace prefix to lookup.
integer	$majorVersion	The major protocol version in effect. Defaults to null (auto-select).
integer	$minorVersion	The minor protocol version in effect. Defaults to null (auto-select).

Returns: string

setAuthor ( $value )

Sets the list of the authors of this feed/entry.

In an atom feed, each author is represented by an atom:author element

Parameters

array $value

Returns: Zend_Gdata_App_FeedEntryParent Provides a fluent interface

setCategory ( $value )

Sets the array of categories that classify this feed/entry.

Each category is represented in an atom feed by an atom:category element.

Parameters

array $value Array of Zend_Gdata_App_Extension_Category

Returns: Zend_Gdata_App_FeedEntryParent Provides a fluent interface

setContributor ( $value )

Sets the array of contributors to this feed/entry.

Each contributor is represented in an atom feed by an atom:contributor XML element

Parameters

array $value

Returns: Zend_Gdata_App_FeedEntryParent Provides a fluent interface

setEtag ( $value )

Set the Etag for the current entry to $value.

Setting $value to null unsets the Etag.

Parameters

string | null $value

Returns: Zend_Gdata_App_Entry Provides a fluent interface

setHttpClient ( Zend_Http_Client $httpClient )

Set the HTTP client instance.

Sets the HTTP client object to use for retrieving the feed.

Deprecated:: Deprecated as of Zend Framework 1.7. Use setService() instead.

Parameters

Zend_Http_Client $httpClient

Returns: Zend_Gdata_App_FeedEntryParent Provides a fluent interface

setId ( $value )

Parameters

Zend_Gdata_App_Extension_Id $value

Returns: Zend_Gdata_App_FeedEntryParent Provides a fluent interface

setLink ( $value )

Parameters

array $value The array of Zend_Gdata_App_Extension_Link elements

Returns: Zend_Gdata_App_FeedEntryParent Provides a fluent interface

setMajorProtocolVersion ( $value )

Set the major protocol version that should be used.

Values < 1 (excluding NULL) will cause a Zend_Gdata_App_InvalidArgumentException to be thrown.

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.

See Also: _minorProtocolVersion

Parameters

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

Exceptions

Zend_Gdata_App_InvalidArgumentException

setRights ( $value )

Parameters

Zend_Gdata_App_Extension_Rights $value

Returns: Zend_Gdata_App_FeedEntryParent Provides a fluent interface

setService ( $instance )

Set the active service instance for this object.

This will be used to perform network requests, such as when calling save() and delete().

Parameters

Zend_Gdata_App $instance The new service instance.

Returns: Zend_Gdata_App_FeedEntryParent Provides a fluent interface.

setTitle ( $value )

Returns the title of this feed or entry.

The title is an extremely short textual representation of this resource and is found as an atom:title element in a feed or entry

Parameters

Zend_Gdata_App_Extension_Title $value

Returns: Zend_Gdata_App_FeedEntryParent Provides a fluent interface

setUpdated ( $value )

Parameters

Zend_Gdata_App_Extension_Updated $value

Returns: Zend_Gdata_App_FeedEntryParent Provides a fluent interface

takeChildFromDOM ( $child )

protected

Member Data Documentation

$_author = array()

protected

$_category = array()

protected

$_contributor = array()

protected

$_etag = NULL

protected

$_id = null

protected

$_link = array()

protected

$_majorProtocolVersion = 1

protected

Indicates the major protocol version that should be used.

At present, recognized values are either 1 or 2. However, any integer value >= 1 is considered valid.

See Also: setMajorProtocolVersion(); getMajorProtocolVersion()

$_minorProtocolVersion = null

protected

Indicates the minor protocol version that should be used.

Can be set to either an integer >= 0, or NULL if no minor version should be sent to the server.

See Also: setMinorProtocolVersion(); getMinorProtocolVersion()

$_rights = null

protected

$_service = null

protected

Service instance used to make network requests.

See Also: setService(), getService()

$_title = null

protected

$_updated = null

protected

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation