Abstract Class Zend_Gdata_App_FeedEntryParent

Description

Abstract class for common functionality in entries and feeds

  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • abstract:
  • license: New BSD License

Located in /Gdata/App/FeedEntryParent.php (line 83)

Zend_Gdata_App_Base
   |
   --Zend_Gdata_App_FeedEntryParent
Direct descendents
Class Description
Abstract class Zend_Gdata_App_FeedSourceParent Atom feed class
 class Zend_Gdata_App_Entry Concrete class for working with Atom entries.
Variable Summary
 mixed $_author
 mixed $_category
 string|null $_etag
 mixed $_id
 mixed $_link
 mixed $_rights
 mixed $_service
 mixed $_title
 mixed $_updated
Method Summary
 Zend_Gdata_App_FeedEntryParent __construct ([ $element = null])
 array getCategory ()
 array getContributor ()
 void getDOM ([ $doc = null], [ $majorVersion = 1], [ $minorVersion = null])
 string|null getEtag ()
 Zend_Http_Client_Abstract getHttpClient ()
 mixed getLink ([string $rel = null])
 (int|NULL) getMajorProtocolVersion ()
 (int|NULL) getMinorProtocolVersion ()
 Zend_Gdata_AppExtension_Rights getRights ()
 string getTitleValue ()
 string lookupNamespace (string $prefix, [integer $majorVersion = null], [integer $minorVersion = null])
 Zend_Gdata_App_Entry setEtag (string|null $value)
 void setMajorProtocolVersion ((int|NULL) $value)
 void setMinorProtocolVersion ((int|NULL) $value)
 void takeChildFromDOM ( $child)
Variables
mixed $_author = array() (line 100)
  • access: protected
mixed $_category = array() (line 101)
  • access: protected
mixed $_contributor = array() (line 102)
  • access: protected
string|null $_etag = NULL (line 98)

The HTTP ETag associated with this entry. Used for optimistic concurrency in protoco v2 or greater.

  • access: protected
mixed $_id = null (line 103)
  • access: protected
mixed $_link = array() (line 104)
  • access: protected
mixed $_majorProtocolVersion = 1 (line 117)

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.

mixed $_minorProtocolVersion = null (line 127)

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.

mixed $_rights = null (line 105)
  • access: protected
mixed $_service = null (line 90)

Service instance used to make network requests.

mixed $_title = null (line 106)
  • access: protected
mixed $_updated = null (line 107)
  • access: protected

Inherited Variables

Inherited from Zend_Gdata_App_Base

Zend_Gdata_App_Base::$_extensionAttributes
Zend_Gdata_App_Base::$_extensionElements
Zend_Gdata_App_Base::$_namespaceLookupCache
Zend_Gdata_App_Base::$_namespaces
Zend_Gdata_App_Base::$_rootElement
Zend_Gdata_App_Base::$_rootNamespace
Zend_Gdata_App_Base::$_rootNamespaceURI
Zend_Gdata_App_Base::$_text
Methods
Constructor __construct (line 132)

Constructs a Feed or Entry

  • access: public
Zend_Gdata_App_FeedEntryParent __construct ([ $element = null])
  • $element

Redefinition of:
Zend_Gdata_App_Base::__construct()

Redefined in descendants as:
getAlternateLink (line 470)

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

  • return: The link, or null if not found
  • access: public
Zend_Gdata_App_Extension_Link getAlternateLink ()
getAuthor (line 287)
  • access: public
getCategory (line 311)

Returns the array of categories that classify this feed/entry. Each category is represented in an atom feed by an atom:category element.

  • return: Array of Zend_Gdata_App_Extension_Category
  • access: public
array getCategory ()
getContributor (line 335)

Returns the array of contributors to this feed/entry. Each contributor is represented in an atom feed by an atom:contributor XML element

  • return: An array of Zend_Gdata_App_Extension_Contributor
  • access: public
array getContributor ()
getDOM (line 204)
  • access: public
void getDOM ([ $doc = null], [ $majorVersion = 1], [ $minorVersion = null])
  • $doc
  • $majorVersion
  • $minorVersion

Redefinition of:
Zend_Gdata_App_Base::getDOM()
Retrieves a DOMElement which corresponds to this element and all child properties. This is used to build an entry back into a DOM and eventually XML text for sending to the server upon updates, or for application storage/persistence.

Redefined in descendants as:
getEditLink (line 407)

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

  • return: The link, or null if not found
  • access: public
getEtag (line 580)

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

  • access: public
string|null getEtag ()
getHttpClient (line 170)

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.
  • access: public
Zend_Http_Client_Abstract getHttpClient ()
getId (line 356)
  • access: public
getLicenseLink (line 441)
  • access: public
Zend_Gdata_App_Extension_Link getLicenseLink ()
getLink (line 386)

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/@rel attribute. Example rel values include 'self', 'edit', and 'alternate'.

  • return: 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
  • access: public
mixed getLink ([string $rel = null])
  • string $rel: The rel value of the link to be found. If null, the array of Zend_Gdata_App_Extension_link elements is returned
getMajorProtocolVersion (line 609)

Get the major protocol version that is in use.

(int|NULL) getMajorProtocolVersion ()
getMinorProtocolVersion (line 640)

Get the minor protocol version that is in use.

(int|NULL) getMinorProtocolVersion ()
getNextLink (line 420)

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

  • return: The link, or null if not found
  • access: public
getPreviousLink (line 433)

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

  • return: The link, or null if not found
  • access: public
Zend_Gdata_App_Extension_Link getPreviousLink ()
getRights (line 488)
  • access: public
Zend_Gdata_AppExtension_Rights getRights ()
getSelfLink (line 454)

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

  • return: The link, or null if not found
  • access: public
getService (line 199)

Get the active service instance for this object. This will be used to perform network requests, such as when calling save() and delete().

  • return: The current service instance, or null if not set.
  • access: public
Zend_Gdata_App|null getService ()
getTitle (line 510)

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

  • access: public
getTitleValue (line 522)

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

  • access: public
string getTitleValue ()
getUpdated (line 548)
  • access: public
lookupNamespace (line 665)

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.

  • access: public
string lookupNamespace (string $prefix, [integer $majorVersion = null], [integer $minorVersion = null])
  • 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).

Redefinition of:
Zend_Gdata_App_Base::lookupNamespace()
Get the full version of a namespace prefix
setAuthor (line 299)

Sets the list of the authors of this feed/entry. In an atom feed, each author is represented by an atom:author element

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_App_FeedEntryParent setAuthor (array $value)
  • array $value
setCategory (line 323)

Sets the array of categories that classify this feed/entry. Each category is represented in an atom feed by an atom:category element.

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_App_FeedEntryParent setCategory (array $value)
  • array $value: Array of Zend_Gdata_App_Extension_Category
setContributor (line 347)

Sets the array of contributors to this feed/entry. Each contributor is represented in an atom feed by an atom:contributor XML element

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_App_FeedEntryParent setContributor (array $value)
  • array $value
setEtag (line 570)

Set the Etag for the current entry to $value. Setting $value to null unsets the Etag.

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_App_Entry setEtag (string|null $value)
  • string|null $value
setHttpClient (line 153)

Set the HTTP client instance

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

  • return: Provides a fluent interface
  • deprecated: Deprecated as of Zend Framework 1.7. Use setService() instead.
  • access: public
Zend_Gdata_App_FeedEntryParent setHttpClient ( $httpClient)

Redefined in descendants as:
setId (line 365)
  • return: Provides a fluent interface
  • access: public
setLink (line 479)
  • return: Provides a fluent interface
  • access: public
Zend_Gdata_App_FeedEntryParent setLink (array $value)
  • array $value: The array of Zend_Gdata_App_Extension_Link elements
setMajorProtocolVersion (line 593)

Set the major protocol version that should be used. Values < 1 (excluding NULL) will cause a Zend_Gdata_App_InvalidArgumentException to be thrown.

void setMajorProtocolVersion ((int|NULL) $value)
  • (int|NULL) $value: The major protocol version to use.

Redefined in descendants as:
setMinorProtocolVersion (line 623)

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.

void setMinorProtocolVersion ((int|NULL) $value)
  • (int|NULL) $value: The minor protocol version to use.

Redefined in descendants as:
  • Zend_Gdata_App_Feed::setMinorProtocolVersion() : 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.
setRights (line 497)
  • return: Provides a fluent interface
  • access: public
setService (line 186)

Set the active service instance for this object. This will be used to perform network requests, such as when calling save() and delete().

  • return: Provides a fluent interface.
  • access: public

Redefined in descendants as:
setTitle (line 539)

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

  • return: Provides a fluent interface
  • access: public
setUpdated (line 557)
  • return: Provides a fluent interface
  • access: public
takeChildFromDOM (line 234)
  • access: protected
void takeChildFromDOM ( $child)
  • $child

Redefinition of:
Zend_Gdata_App_Base::takeChildFromDOM()
Given a child DOMNode, tries to determine how to map the data into object instance members. If no mapping is defined, Extension_Element objects are created and stored in an array.

Redefined in descendants as:

Inherited Methods

Inherited From Zend_Gdata_App_Base

 Zend_Gdata_App_Base::__construct()
 Zend_Gdata_App_Base::encode()
 Zend_Gdata_App_Base::flushNamespaceLookupCache()
 Zend_Gdata_App_Base::getDOM()
 Zend_Gdata_App_Base::getExtensionAttributes()
 Zend_Gdata_App_Base::getExtensionElements()
 Zend_Gdata_App_Base::getText()
 Zend_Gdata_App_Base::getXML()
 Zend_Gdata_App_Base::lookupNamespace()
 Zend_Gdata_App_Base::registerAllNamespaces()
 Zend_Gdata_App_Base::registerNamespace()
 Zend_Gdata_App_Base::saveXML()
 Zend_Gdata_App_Base::setExtensionAttributes()
 Zend_Gdata_App_Base::setExtensionElements()
 Zend_Gdata_App_Base::setText()
 Zend_Gdata_App_Base::takeAttributeFromDOM()
 Zend_Gdata_App_Base::takeChildFromDOM()
 Zend_Gdata_App_Base::transferFromDOM()
 Zend_Gdata_App_Base::transferFromXML()
 Zend_Gdata_App_Base::__get()
 Zend_Gdata_App_Base::__isset()
 Zend_Gdata_App_Base::__set()
 Zend_Gdata_App_Base::__toString()
 Zend_Gdata_App_Base::__unset()

Documentation generated on Mon, 21 Jun 2010 15:22:51 -0400 by phpDocumentor 1.4.3