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

Public Member Functions

 __construct ($element=null)
 Constructor for Zend_Gdata_Books_VolumeEntry which Describes an entry in a feed of Book Search volumes.
 
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 Retrieves DOMElement which corresponds to this element and all child properties.
 
 getComments ()
 Returns the Comments class.
 
 getCreators ()
 Returns the creators.
 
 getDates ()
 Returns the dates.
 
 getDescriptions ()
 Returns the descriptions.
 
 getEmbeddability ()
 Returns the embeddability.
 
 getFormats ()
 Returns the formats.
 
 getIdentifiers ()
 Returns the identifiers.
 
 getLanguages ()
 Returns the languages.
 
 getPublishers ()
 Returns the publishers.
 
 getRating ()
 Returns the rating.
 
 getReview ()
 Returns the review.
 
 getSubjects ()
 Returns the subjects.
 
 getTitles ()
 Returns the titles.
 
 getViewability ()
 Returns the viewability.
 
 setComments ($comments)
 Sets the Comments class.
 
 setCreators ($creators)
 Sets the creators.
 
 setDates ($dates)
 Sets the dates.
 
 setDescriptions ($descriptions)
 Sets the descriptions.
 
 setEmbeddability ($embeddability)
 Sets the embeddability.
 
 setFormats ($formats)
 Sets the formats.
 
 setIdentifiers ($identifiers)
 Sets the identifiers.
 
 setLanguages ($languages)
 Sets the languages.
 
 setPublishers ($publishers)
 Sets the publishers.
 
 setRating ($rating)
 Sets the rating.
 
 setReview ($review)
 Sets the review.
 
 setSubjects ($subjects)
 Sets the subjects.
 
 setTitles ($titles)
 Sets the titles.
 
 setViewability ($viewability)
 Sets the viewability.
 
 getVolumeId ()
 Gets the volume ID based upon the atom:id value.
 
 getThumbnailLink ()
 Gets the thumbnail link.
 
 getPreviewLink ()
 Gets the preview link.
 
 getInfoLink ()
 Gets the info link.
 
 getAnnotationLink ()
 Gets the annotations link.
 
- Public Member Functions inherited from Zend_Gdata_Entry
 __construct ($element=null)
 
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 
- Public Member Functions inherited from Zend_Gdata_App_MediaEntry
 __construct ($element=null, $mediaSource=null)
 Constructs a new MediaEntry, representing XML data and optional file to upload.
 
 encode ()
 Return the MIME multipart representation of this MediaEntry.
 
 getMediaSource ()
 Return the MediaSource object representing the file attached to this MediaEntry.
 
 setMediaSource ($value)
 Set the MediaSource object (file) for this MediaEntry.
 
- Public Member Functions inherited from Zend_Gdata_App_Entry
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 
 save ($uri=null, $className=null, $extraHeaders=array())
 Uploads changes in this entry to the server using Zend_Gdata_App.
 
 delete ()
 Deletes this entry to the server using the referenced Zend_Http_Client to do a HTTP DELETE to the edit link stored in this entry's link collection.
 
 reload ($uri=null, $className=null, $extraHeaders=array())
 Reload the current entry.
 
 getContent ()
 Gets the value of the atom:content element.
 
 setContent ($value)
 Sets the value of the atom:content element.
 
 getPublished ()
 Sets the value of the atom:published element This represents the publishing date for an entry.
 
 setPublished ($value)
 Sets the value of the atom:published element This represents the publishing date for an entry.
 
 getSource ()
 Gets the value of the atom:source element.
 
 setSource ($value)
 Sets the value of the atom:source element.
 
 getSummary ()
 Gets the value of the atom:summary element This represents a textual summary of this entry's content.
 
 setSummary ($value)
 Sets the value of the atom:summary element This represents a textual summary of this entry's content.
 
 getControl ()
 Gets the value of the app:control element.
 
 setControl ($value)
 Sets the value of the app:control element.
 
- 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.
 

Public Attributes

const THUMBNAIL_LINK_REL = 'http://schemas.google.com/books/2008/thumbnail'
 
const PREVIEW_LINK_REL = 'http://schemas.google.com/books/2008/preview'
 
const INFO_LINK_REL = 'http://schemas.google.com/books/2008/info'
 
const ANNOTATION_LINK_REL = 'http://schemas.google.com/books/2008/annotation'
 

Protected Member Functions

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

Protected Attributes

 $_comments = null
 
 $_creators = array()
 
 $_dates = array()
 
 $_descriptions = array()
 
 $_embeddability = null
 
 $_formats = array()
 
 $_identifiers = array()
 
 $_languages = array()
 
 $_publishers = array()
 
 $_rating = null
 
 $_review = null
 
 $_subjects = array()
 
 $_titles = array()
 
 $_viewability = null
 
- Protected Attributes inherited from Zend_Gdata_Entry
 $_entryClassName = 'Zend_Gdata_Entry'
 
- Protected Attributes inherited from Zend_Gdata_App_MediaEntry
 $_mediaSource = null
 
- Protected Attributes inherited from Zend_Gdata_App_Entry
 $_rootElement = 'entry'
 
 $_entryClassName = 'Zend_Gdata_App_Entry'
 
 $_content = null
 
 $_published = null
 
 $_source = null
 
 $_summary = null
 
 $_control = null
 
 $_edited = 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()
 

Constructor & Destructor Documentation

__construct (   $element = null)

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

Parameters
DOMElement$element(optional) DOMElement from which this object should be constructed.

Member Function Documentation

getAnnotationLink ( )

Gets the annotations link.

Returns
Zend_Gdata_App_Extension_Link|null The annotations link
getComments ( )

Returns the Comments class.

Returns
Zend_Gdata_Extension_Comments|null The comments
getCreators ( )

Returns the creators.

Returns
array The creators
getDates ( )

Returns the dates.

Returns
array The dates
getDescriptions ( )

Returns the descriptions.

Returns
array The descriptions
getDOM (   $doc = null,
  $majorVersion = 1,
  $minorVersion = null 
)

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.

Parameters
DOMDocument$docThe DOMDocument used to construct DOMElements
Returns
DOMElement The DOMElement representing this element and all child properties.
getEmbeddability ( )

Returns the embeddability.

Returns
Zend_Gdata_Books_Extension_Embeddability|null The embeddability
getFormats ( )

Returns the formats.

Returns
array The formats
getIdentifiers ( )

Returns the identifiers.

Returns
array The identifiers
getInfoLink ( )

Gets the info link.

Returns
Zend_Gdata_App_Extension_Link|null The info link
getLanguages ( )

Returns the languages.

Returns
array The languages
getPreviewLink ( )

Gets the preview link.

Returns
Zend_Gdata_App_Extension_Link|null The preview link
getPublishers ( )

Returns the publishers.

Returns
array The publishers
getRating ( )

Returns the rating.

Returns
Zend_Gdata_Extension_Rating|null The rating
getReview ( )

Returns the review.

Returns
Zend_Gdata_Books_Extension_Review|null The review
getSubjects ( )

Returns the subjects.

Returns
array The subjects
getThumbnailLink ( )

Gets the thumbnail link.

Returns
Zend_Gdata_App_Extension_link|null The thumbnail link
getTitles ( )

Returns the titles.

Returns
array The titles
getViewability ( )

Returns the viewability.

Returns
Zend_Gdata_Books_Extension_Viewability|null The viewability
getVolumeId ( )

Gets the volume ID based upon the atom:id value.

Returns
string The volume ID
Exceptions
Zend_Gdata_App_Exception
setComments (   $comments)

Sets the Comments class.

Parameters
Zend_Gdata_Extension_Comments | null$commentsComments class
Returns
Zend_Gdata_Books_VolumeEntry Provides a fluent interface
setCreators (   $creators)

Sets the creators.

Parameters
array$creatorsCreators|null
Returns
Zend_Gdata_Books_VolumeEntry Provides a fluent interface
setDates (   $dates)

Sets the dates.

Parameters
array$datesdates
Returns
Zend_Gdata_Books_VolumeEntry Provides a fluent interface
setDescriptions (   $descriptions)

Sets the descriptions.

Parameters
array$descriptionsdescriptions
Returns
Zend_Gdata_Books_VolumeEntry Provides a fluent interface
setEmbeddability (   $embeddability)

Sets the embeddability.

Parameters
Zend_Gdata_Books_Extension_Embeddability | null$embeddabilityembeddability
Returns
Zend_Gdata_Books_VolumeEntry Provides a fluent interface
setFormats (   $formats)

Sets the formats.

Parameters
array$formatsformats
Returns
Zend_Gdata_Books_VolumeEntry Provides a fluent interface
setIdentifiers (   $identifiers)

Sets the identifiers.

Parameters
array$identifiersidentifiers
Returns
Zend_Gdata_Books_VolumeEntry Provides a fluent interface
setLanguages (   $languages)

Sets the languages.

Parameters
array$languageslanguages
Returns
Zend_Gdata_Books_VolumeEntry Provides a fluent interface
setPublishers (   $publishers)

Sets the publishers.

Parameters
array$publisherspublishers
Returns
Zend_Gdata_Books_VolumeEntry Provides a fluent interface
setRating (   $rating)

Sets the rating.

Parameters
Zend_Gdata_Extension_Rating | null$ratingrating
Returns
Zend_Gdata_Books_VolumeEntry Provides a fluent interface
setReview (   $review)

Sets the review.

Parameters
Zend_Gdata_Books_Extension_Review | null$reviewreview
Returns
Zend_Gdata_Books_VolumeEntry Provides a fluent interface
setSubjects (   $subjects)

Sets the subjects.

Parameters
array$subjectssubjects
Returns
Zend_Gdata_Books_VolumeEntry Provides a fluent interface
setTitles (   $titles)

Sets the titles.

Parameters
array$titlestitles
Returns
Zend_Gdata_Books_VolumeEntry Provides a fluent interface
setViewability (   $viewability)

Sets the viewability.

Parameters
Zend_Gdata_Books_Extension_Viewability | null$viewabilityviewability
Returns
Zend_Gdata_Books_VolumeEntry Provides a fluent interface
takeChildFromDOM (   $child)
protected

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

Parameters
DOMNode$childThe DOMNode to process.

Member Data Documentation

$_comments = null
protected
$_creators = array()
protected
$_dates = array()
protected
$_descriptions = array()
protected
$_embeddability = null
protected
$_formats = array()
protected
$_identifiers = array()
protected
$_languages = array()
protected
$_publishers = array()
protected
$_rating = null
protected
$_review = null
protected
$_subjects = array()
protected
$_titles = array()
protected
$_viewability = null
protected
const ANNOTATION_LINK_REL = 'http://schemas.google.com/books/2008/annotation'
const INFO_LINK_REL = 'http://schemas.google.com/books/2008/info'
const PREVIEW_LINK_REL = 'http://schemas.google.com/books/2008/preview'
const THUMBNAIL_LINK_REL = 'http://schemas.google.com/books/2008/thumbnail'