Class Zend_Gdata_Books_VolumeEntry

Description

Describes an entry in a feed of Book Search volumes

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

Located in /Gdata/Books/VolumeEntry.php (line 108)

Zend_Gdata_App_Base
   |
   --Zend_Gdata_App_FeedEntryParent
      |
      --Zend_Gdata_App_Entry
         |
         --Zend_Gdata_App_MediaEntry
            |
            --Zend_Gdata_Entry
               |
               --Zend_Gdata_Books_VolumeEntry
Class Constant Summary
 ANNOTATION_LINK_REL = 'http://schemas.google.com/books/2008/annotation'
 INFO_LINK_REL = 'http://schemas.google.com/books/2008/info'
 PREVIEW_LINK_REL = 'http://schemas.google.com/books/2008/preview'
 THUMBNAIL_LINK_REL = 'http://schemas.google.com/books/2008/thumbnail'
Variable Summary
 mixed $_comments
 mixed $_creators
 mixed $_dates
 mixed $_formats
 mixed $_languages
 mixed $_publishers
 mixed $_rating
 mixed $_review
 mixed $_subjects
 mixed $_titles
Method Summary
 Zend_Gdata_Books_VolumeEntry __construct ([DOMElement $element = null])
 array getCreators ()
 array getDates ()
 array getDescriptions ()
 DOMElement getDOM ([DOMDocument $doc = null], [ $majorVersion = 1], [ $minorVersion = null])
 array getFormats ()
 array getIdentifiers ()
 array getLanguages ()
 array getPublishers ()
 array getSubjects ()
 Zend_Gdata_App_Extension_link|null getThumbnailLink ()
 array getTitles ()
 string getVolumeId ()
 void takeChildFromDOM (DOMNode $child)
Variables
mixed $_comments = null (line 116)
  • access: protected
mixed $_creators = array() (line 117)
  • access: protected
mixed $_dates = array() (line 118)
  • access: protected
mixed $_descriptions = array() (line 119)
  • access: protected
mixed $_embeddability = null (line 120)
  • access: protected
mixed $_formats = array() (line 121)
  • access: protected
mixed $_identifiers = array() (line 122)
  • access: protected
mixed $_languages = array() (line 123)
  • access: protected
mixed $_publishers = array() (line 124)
  • access: protected
mixed $_rating = null (line 125)
  • access: protected
mixed $_review = null (line 126)
  • access: protected
mixed $_subjects = array() (line 127)
  • access: protected
mixed $_titles = array() (line 128)
  • access: protected
mixed $_viewability = null (line 129)
  • access: protected

Inherited Variables

Inherited from Zend_Gdata_Entry

Zend_Gdata_Entry::$_entryClassName

Inherited from Zend_Gdata_App_MediaEntry

Zend_Gdata_App_MediaEntry::$_mediaSource

Inherited from Zend_Gdata_App_Entry

Zend_Gdata_App_Entry::$_content
Zend_Gdata_App_Entry::$_control
Zend_Gdata_App_Entry::$_edited
Zend_Gdata_App_Entry::$_published
Zend_Gdata_App_Entry::$_rootElement
Zend_Gdata_App_Entry::$_source
Zend_Gdata_App_Entry::$_summary

Inherited from Zend_Gdata_App_FeedEntryParent

Zend_Gdata_App_FeedEntryParent::$_author
Zend_Gdata_App_FeedEntryParent::$_category
Zend_Gdata_App_FeedEntryParent::$_contributor
Zend_Gdata_App_FeedEntryParent::$_etag
Zend_Gdata_App_FeedEntryParent::$_id
Zend_Gdata_App_FeedEntryParent::$_link
Zend_Gdata_App_FeedEntryParent::$_majorProtocolVersion
Zend_Gdata_App_FeedEntryParent::$_minorProtocolVersion
Zend_Gdata_App_FeedEntryParent::$_rights
Zend_Gdata_App_FeedEntryParent::$_service
Zend_Gdata_App_FeedEntryParent::$_title
Zend_Gdata_App_FeedEntryParent::$_updated

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::$_rootNamespace
Zend_Gdata_App_Base::$_rootNamespaceURI
Zend_Gdata_App_Base::$_text
Methods
Constructor __construct (line 138)

Constructor for Zend_Gdata_Books_VolumeEntry which Describes an entry in a feed of Book Search volumes

  • access: public
Zend_Gdata_Books_VolumeEntry __construct ([DOMElement $element = null])
  • DOMElement $element: (optional) DOMElement from which this object should be constructed.

Redefinition of:
Zend_Gdata_Entry::__construct()
getAnnotationLink (line 682)

Gets the annotations link

  • return: The annotations link
  • access: public
Zend_Gdata_App_Extension_Link|null getAnnotationLink ()
getComments (line 323)

Returns the Comments class

  • return: The comments
  • access: public
Zend_Gdata_Extension_Comments|null getComments ()
getCreators (line 333)

Returns the creators

  • return: The creators
  • access: public
array getCreators ()
getDates (line 343)

Returns the dates

  • return: The dates
  • access: public
array getDates ()
getDescriptions (line 353)

Returns the descriptions

  • return: The descriptions
  • access: public
array getDescriptions ()
getDOM (line 154)

Retrieves DOMElement which corresponds to this element and all child properties. This is used to build this object back into a DOM and eventually XML text for sending to the server upon updates, or for application storage/persistance.

  • return: The DOMElement representing this element and all child properties.
  • access: public
DOMElement getDOM ([DOMDocument $doc = null], [ $majorVersion = 1], [ $minorVersion = null])
  • DOMDocument $doc: The DOMDocument used to construct DOMElements
  • $majorVersion
  • $minorVersion

Redefinition of:
Zend_Gdata_Entry::getDOM()
getEmbeddability (line 363)

Returns the embeddability

  • return: The embeddability
  • access: public
Zend_Gdata_Books_Extension_Embeddability|null getEmbeddability ()
getFormats (line 373)

Returns the formats

  • return: The formats
  • access: public
array getFormats ()
getIdentifiers (line 383)

Returns the identifiers

  • return: The identifiers
  • access: public
array getIdentifiers ()
getInfoLink (line 672)

Gets the info link

  • return: The info link
  • access: public
Zend_Gdata_App_Extension_Link|null getInfoLink ()
getLanguages (line 393)

Returns the languages

  • return: The languages
  • access: public
array getLanguages ()
getPreviewLink (line 662)

Gets the preview link

  • return: The preview link
  • access: public
Zend_Gdata_App_Extension_Link|null getPreviewLink ()
getPublishers (line 403)

Returns the publishers

  • return: The publishers
  • access: public
array getPublishers ()
getRating (line 413)

Returns the rating

  • return: The rating
  • access: public
Zend_Gdata_Extension_Rating|null getRating ()
getReview (line 423)

Returns the review

  • return: The review
  • access: public
getSubjects (line 433)

Returns the subjects

  • return: The subjects
  • access: public
array getSubjects ()
getThumbnailLink (line 652)

Gets the thumbnail link

  • return: The thumbnail link
  • access: public
Zend_Gdata_App_Extension_link|null getThumbnailLink ()
getTitles (line 443)

Returns the titles

  • return: The titles
  • access: public
array getTitles ()
getViewability (line 453)

Returns the viewability

  • return: The viewability
  • access: public
getVolumeId (line 635)

Gets the volume ID based upon the atom:id value

  • return: The volume ID
  • throws: Zend_Gdata_App_Exception
  • access: public
string getVolumeId ()
setComments (line 464)

Sets the Comments class

  • return: Provides a fluent interface
  • access: public
setCreators (line 476)

Sets the creators

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_Books_VolumeEntry setCreators (array $creators)
  • array $creators: Creators|null
setDates (line 488)

Sets the dates

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_Books_VolumeEntry setDates (array $dates)
  • array $dates: dates
setDescriptions (line 500)

Sets the descriptions

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_Books_VolumeEntry setDescriptions (array $descriptions)
  • array $descriptions: descriptions
setEmbeddability (line 513)

Sets the embeddability

  • return: Provides a fluent interface
  • access: public
setFormats (line 525)

Sets the formats

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_Books_VolumeEntry setFormats (array $formats)
  • array $formats: formats
setIdentifiers (line 537)

Sets the identifiers

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_Books_VolumeEntry setIdentifiers (array $identifiers)
  • array $identifiers: identifiers
setLanguages (line 549)

Sets the languages

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_Books_VolumeEntry setLanguages (array $languages)
  • array $languages: languages
setPublishers (line 561)

Sets the publishers

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_Books_VolumeEntry setPublishers (array $publishers)
  • array $publishers: publishers
setRating (line 573)

Sets the rating

  • return: Provides a fluent interface
  • access: public
setReview (line 585)

Sets the review

  • return: Provides a fluent interface
  • access: public
setSubjects (line 597)

Sets the subjects

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_Books_VolumeEntry setSubjects (array $subjects)
  • array $subjects: subjects
setTitles (line 609)

Sets the titles

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_Books_VolumeEntry setTitles (array $titles)
  • array $titles: titles
setViewability (line 622)

Sets the viewability

  • return: Provides a fluent interface
  • access: public
takeChildFromDOM (line 238)

Creates individual objects of the appropriate type and stores them in this object based upon DOM data.

  • access: protected
void takeChildFromDOM (DOMNode $child)
  • DOMNode $child: The DOMNode to process.

Redefinition of:
Zend_Gdata_Entry::takeChildFromDOM()

Inherited Methods

Inherited From Zend_Gdata_Entry

 Zend_Gdata_Entry::__construct()
 Zend_Gdata_Entry::getDOM()
 Zend_Gdata_Entry::takeAttributeFromDOM()
 Zend_Gdata_Entry::takeChildFromDOM()

Inherited From Zend_Gdata_App_MediaEntry

 Zend_Gdata_App_MediaEntry::__construct()
 Zend_Gdata_App_MediaEntry::encode()
 Zend_Gdata_App_MediaEntry::getMediaSource()
 Zend_Gdata_App_MediaEntry::setMediaSource()

Inherited From Zend_Gdata_App_Entry

 Zend_Gdata_App_Entry::delete()
 Zend_Gdata_App_Entry::getContent()
 Zend_Gdata_App_Entry::getControl()
 Zend_Gdata_App_Entry::getDOM()
 Zend_Gdata_App_Entry::getPublished()
 Zend_Gdata_App_Entry::getSource()
 Zend_Gdata_App_Entry::getSummary()
 Zend_Gdata_App_Entry::reload()
 Zend_Gdata_App_Entry::save()
 Zend_Gdata_App_Entry::setContent()
 Zend_Gdata_App_Entry::setControl()
 Zend_Gdata_App_Entry::setPublished()
 Zend_Gdata_App_Entry::setSource()
 Zend_Gdata_App_Entry::setSummary()
 Zend_Gdata_App_Entry::takeChildFromDOM()

Inherited From Zend_Gdata_App_FeedEntryParent

 Zend_Gdata_App_FeedEntryParent::__construct()
 Zend_Gdata_App_FeedEntryParent::getAlternateLink()
 Zend_Gdata_App_FeedEntryParent::getAuthor()
 Zend_Gdata_App_FeedEntryParent::getCategory()
 Zend_Gdata_App_FeedEntryParent::getContributor()
 Zend_Gdata_App_FeedEntryParent::getDOM()
 Zend_Gdata_App_FeedEntryParent::getEditLink()
 Zend_Gdata_App_FeedEntryParent::getEtag()
 Zend_Gdata_App_FeedEntryParent::getHttpClient()
 Zend_Gdata_App_FeedEntryParent::getId()
 Zend_Gdata_App_FeedEntryParent::getLicenseLink()
 Zend_Gdata_App_FeedEntryParent::getLink()
 Zend_Gdata_App_FeedEntryParent::getMajorProtocolVersion()
 Zend_Gdata_App_FeedEntryParent::getMinorProtocolVersion()
 Zend_Gdata_App_FeedEntryParent::getNextLink()
 Zend_Gdata_App_FeedEntryParent::getPreviousLink()
 Zend_Gdata_App_FeedEntryParent::getRights()
 Zend_Gdata_App_FeedEntryParent::getSelfLink()
 Zend_Gdata_App_FeedEntryParent::getService()
 Zend_Gdata_App_FeedEntryParent::getTitle()
 Zend_Gdata_App_FeedEntryParent::getTitleValue()
 Zend_Gdata_App_FeedEntryParent::getUpdated()
 Zend_Gdata_App_FeedEntryParent::lookupNamespace()
 Zend_Gdata_App_FeedEntryParent::setAuthor()
 Zend_Gdata_App_FeedEntryParent::setCategory()
 Zend_Gdata_App_FeedEntryParent::setContributor()
 Zend_Gdata_App_FeedEntryParent::setEtag()
 Zend_Gdata_App_FeedEntryParent::setHttpClient()
 Zend_Gdata_App_FeedEntryParent::setId()
 Zend_Gdata_App_FeedEntryParent::setLink()
 Zend_Gdata_App_FeedEntryParent::setMajorProtocolVersion()
 Zend_Gdata_App_FeedEntryParent::setMinorProtocolVersion()
 Zend_Gdata_App_FeedEntryParent::setRights()
 Zend_Gdata_App_FeedEntryParent::setService()
 Zend_Gdata_App_FeedEntryParent::setTitle()
 Zend_Gdata_App_FeedEntryParent::setUpdated()
 Zend_Gdata_App_FeedEntryParent::takeChildFromDOM()

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()
Class Constants
ANNOTATION_LINK_REL = 'http://schemas.google.com/books/2008/annotation' (line 114)
INFO_LINK_REL = 'http://schemas.google.com/books/2008/info' (line 113)
PREVIEW_LINK_REL = 'http://schemas.google.com/books/2008/preview' (line 112)
THUMBNAIL_LINK_REL = 'http://schemas.google.com/books/2008/thumbnail' (line 111)

Documentation generated on Mon, 21 Jun 2010 15:52:25 -0400 by phpDocumentor 1.4.3