Describes an entry in a feed of Book Search volumes
category | Zend |
---|---|
package | Zend_Gdata |
subpackage | Books |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
inherited_from | \Zend_Gdata_Entry |
__construct(\DOMElement $element = null
)
inherited_from | \Zend_Gdata_Entry::__construct() |
---|
\DOMElement
(optional) DOMElement from which this object should be constructed.
__construct()
__get(string $name)
TODO Remove ability to bypass getFoo() methods??
string
The variable name sought
__isset(string $name)
string
__set(string $name, $val)
Alternatively, if no setFoo() is defined, but a $_foo protected variable is defined, this is returned.
TODO Remove ability to bypass getFoo() methods??
string
__toString() : string
string
The text representation of this object__unset(string $name)
string
delete() : void
\Zend_Gdata_App_Exception |
---|
encode() : string
Can be overridden by children to provide more complex representations of entries.
string
Encoded string contentflushNamespaceLookupCache()
Empties the namespace lookup cache. Call this function if you have added data to the namespace lookup table that contradicts values that may have been cached during a previous call to lookupNamespace().
getAlternateLink() : \Zend_Gdata_App_Extension_Link
This link is in the atom feed/entry as an atom:link with a rel attribute value of 'self'.
\Zend_Gdata_App_Extension_Link
The link, or null if not foundgetAnnotationLink() : \Zend_Gdata_App_Extension_Link | null
\Zend_Gdata_App_Extension_Link
null
The annotations linkgetAuthor() : \Zend_Gdata_App_Extension_Author
\Zend_Gdata_App_Extension_Author
getCategory() : array
array
Array of Zend_Gdata_App_Extension_CategorygetComments() : \Zend_Gdata_Extension_Comments | null
\Zend_Gdata_Extension_Comments
null
The commentsgetContent() : \Zend_Gdata_App_Extension_Content
\Zend_Gdata_App_Extension_Content
getContributor() : array
array
An array of Zend_Gdata_App_Extension_ContributorgetControl() : \Zend_Gdata_App_Extension_Control
\Zend_Gdata_App_Extension_Control
getCreators() : array
array
The creatorsgetDOM(\DOMDocument $doc= null
, $majorVersion= 1
, $minorVersion= null
) : \DOMElement
inherited_from | \Zend_Gdata_Entry::getDOM() |
---|
\DOMDocument
The DOMDocument used to construct DOMElements
\DOMElement
The DOMElement representing this element and all
child properties.getDOM(\DOMDocument $doc= null
, $majorVersion= 1
, $minorVersion= null
) : \DOMElement
\DOMDocument
The DOMDocument used to construct DOMElements
\DOMElement
The DOMElement representing this element and all
child properties.getDates() : array
array
The datesgetDescriptions() : array
array
The descriptionsgetEditLink() : \Zend_Gdata_App_Extension_Link
\Zend_Gdata_App_Extension_Link
The link, or null if not foundgetEmbeddability() : \Zend_Gdata_Books_Extension_Embeddability | null
\Zend_Gdata_Books_Extension_Embeddability
null
The embeddabilitygetEtag() : string | null
string
null
getExtensionAttributes() : array
array
All extension attributesgetExtensionElements() : array
array
All elements not matched to data model classes during parsinggetFormats() : array
array
The formatsgetHttpClient() : \Zend_Http_Client_Abstract
deprecated | Deprecated as of Zend Framework 1.7. Use getService() instead. |
---|
\Zend_Http_Client_Abstract
getId() : \Zend_Gdata_App_Extension_Id
\Zend_Gdata_App_Extension_Id
getIdentifiers() : array
array
The identifiersgetInfoLink() : \Zend_Gdata_App_Extension_Link | null
\Zend_Gdata_App_Extension_Link
null
The info linkgetLanguages() : array
array
The languagesgetLicenseLink() : \Zend_Gdata_App_Extension_Link
\Zend_Gdata_App_Extension_Link
getLink(string $rel = null
) : mixed
string
The rel value of the link to be found. If null, the array of Zend_Gdata_App_Extension_link elements is returned
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 functiongetMajorProtocolVersion() : \(int | \NULL)
getMediaSource() : \Zend_Gdata_App_MediaSource
\Zend_Gdata_App_MediaSource
The attached MediaSource/filegetMinorProtocolVersion() : \(int | \NULL)
getNextLink() : \Zend_Gdata_App_Extension_Link
\Zend_Gdata_App_Extension_Link
The link, or null if not foundgetPreviewLink() : \Zend_Gdata_App_Extension_Link | null
\Zend_Gdata_App_Extension_Link
null
The preview linkgetPreviousLink() : \Zend_Gdata_App_Extension_Link
\Zend_Gdata_App_Extension_Link
The link, or null if not foundgetPublished() : \Zend_Gdata_App_Extension_Published
\Zend_Gdata_App_Extension_Published
getPublishers() : array
array
The publishersgetRating() : \Zend_Gdata_Extension_Rating | null
\Zend_Gdata_Extension_Rating
null
The ratinggetReview() : \Zend_Gdata_Books_Extension_Review | null
\Zend_Gdata_Books_Extension_Review
null
The reviewgetRights() : \Zend_Gdata_AppExtension_Rights
\Zend_Gdata_AppExtension_Rights
getSelfLink() : \Zend_Gdata_App_Extension_Link
\Zend_Gdata_App_Extension_Link
The link, or null if not foundgetService() : \Zend_Gdata_App | null
\Zend_Gdata_App
null
The current service instance, or null if
not set.getSource() : \Zend_Gdata_App_Extension_Source
\Zend_Gdata_App_Extension_Source
getSubjects() : array
array
The subjectsgetSummary() : \Zend_Gdata_App_Extension_Summary
\Zend_Gdata_App_Extension_Summary
getText($trim = true
) : string
string
Child text nodegetThumbnailLink() : \Zend_Gdata_App_Extension_link | null
\Zend_Gdata_App_Extension_link
null
The thumbnail linkgetTitle() : \Zend_Gdata_App_Extension_Title
\Zend_Gdata_App_Extension_Title
getTitleValue() : string
The title is an extremely short textual representation of this resource and is found as an atom:title element in a feed or entry
string
getTitles() : array
array
The titlesgetUpdated() : \Zend_Gdata_App_Extension_Updated
\Zend_Gdata_App_Extension_Updated
getViewability() : \Zend_Gdata_Books_Extension_Viewability | null
\Zend_Gdata_Books_Extension_Viewability
null
The viewabilitygetVolumeId() : string
\Zend_Gdata_App_Exception |
---|
string
The volume IDgetXML() : string
string
XML contentlookupNamespace(string $prefix, integer $majorVersion= 1
, integer $minorVersion= null
) : string
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.
string
The namespace prefix to lookup.
integer
The major protocol version in effect. Defaults to '1'.
integer
The minor protocol version in effect. Defaults to null (use latest).
string
registerAllNamespaces(array $namespaceArray) : void
Takes an array in the format of: namespace prefix, namespace URI, major protocol version, minor protocol version and adds them with calls to ->registerNamespace()
array
An array of namespaces.
registerNamespace(string $prefix, string $namespaceUri, integer $majorVersion= 1
, integer $minorVersion= 0
) : void
Takes a prefix and a full namespace URI and adds them to the list of registered namespaces for use by $this->lookupNamespace().
WARNING: Currently, registering a namespace will NOT invalidate any memoized data stored in $_namespaceLookupCache. Under normal use, this behavior is acceptable. If you are adding contradictory data to the namespace lookup table, you must call flushNamespaceLookupCache().
string
The namespace prefix
string
The full namespace URI
integer
The major protocol version in effect. Defaults to '1'.
integer
The minor protocol version in effect. Defaults to null (use latest).
reload($uri= null
, $className= null
, array $extraHeaders= array()
) : mixed
array
Extra headers to add to the request, as an array of string-based key/value pairs.
\Zend_Gdata_App_Exception |
---|
mixed
A new instance of the current entry with updated data, or
null if the server reports that no changes have been made.save(string|null $uri= null
, string|null $className= null
, array $extraHeaders= array()
) : \Zend_Gdata_App_Entry
string
null
The URI to send requests to, or null if $data contains the URI.
string
null
The name of the class that should we deserializing the server response. If null, then 'Zend_Gdata_App_Entry' will be used.
array
Extra headers to add to the request, as an array of string-based key/value pairs.
\Zend_Gdata_App_Exception |
---|
\Zend_Gdata_App_Entry
The updated entry.saveXML() : string
string
XML contentsetAuthor(array $value) : \Zend_Gdata_App_FeedEntryParent
array
\Zend_Gdata_App_FeedEntryParent
Provides a fluent interfacesetCategory(array $value) : \Zend_Gdata_App_FeedEntryParent
array
Array of Zend_Gdata_App_Extension_Category
\Zend_Gdata_App_FeedEntryParent
Provides a fluent interfacesetComments(\Zend_Gdata_Extension_Comments|null $comments) : \Zend_Gdata_Books_VolumeEntry
\Zend_Gdata_Extension_Comments
null
Comments class
\Zend_Gdata_Books_VolumeEntry
Provides a fluent interfacesetContent(\Zend_Gdata_App_Extension_Content $value) : \Zend_Gdata_App_Entry
\Zend_Gdata_App_Extension_Content
\Zend_Gdata_App_Entry
Provides a fluent interfacesetContributor(array $value) : \Zend_Gdata_App_FeedEntryParent
array
\Zend_Gdata_App_FeedEntryParent
Provides a fluent interfacesetControl(\Zend_Gdata_App_Extension_Control $value) : \Zend_Gdata_App_Entry
\Zend_Gdata_App_Extension_Control
\Zend_Gdata_App_Entry
Provides a fluent interfacesetCreators(array $creators) : \Zend_Gdata_Books_VolumeEntry
array
Creators|null
\Zend_Gdata_Books_VolumeEntry
Provides a fluent interfacesetDates(array $dates) : \Zend_Gdata_Books_VolumeEntry
array
dates
\Zend_Gdata_Books_VolumeEntry
Provides a fluent interfacesetDescriptions(array $descriptions) : \Zend_Gdata_Books_VolumeEntry
array
descriptions
\Zend_Gdata_Books_VolumeEntry
Provides a fluent interfacesetEmbeddability(\Zend_Gdata_Books_Extension_Embeddability|null $embeddability) : \Zend_Gdata_Books_VolumeEntry
\Zend_Gdata_Books_Extension_Embeddability
null
embeddability
\Zend_Gdata_Books_VolumeEntry
Provides a fluent interfacesetEtag(string|null $value) : \Zend_Gdata_App_Entry
string
null
\Zend_Gdata_App_Entry
Provides a fluent interfacesetExtensionAttributes(array $value) : \Zend_Gdata_App_Base
array
All extension attributes
\Zend_Gdata_App_Base
Returns an object of the same type as 'this' to provide a fluent interface.setExtensionElements(array $value) : \Zend_Gdata_App_Base
array
All extension elements
\Zend_Gdata_App_Base
Returns an object of the same type as 'this' to provide a fluent interface.setFormats(array $formats) : \Zend_Gdata_Books_VolumeEntry
array
formats
\Zend_Gdata_Books_VolumeEntry
Provides a fluent interfacesetHttpClient(\Zend_Http_Client $httpClient) : \Zend_Gdata_App_FeedEntryParent
Sets the HTTP client object to use for retrieving the feed.
deprecated | Deprecated as of Zend Framework 1.7. Use setService() instead. |
---|
\Zend_Http_Client
\Zend_Gdata_App_FeedEntryParent
Provides a fluent interfacesetId(\Zend_Gdata_App_Extension_Id $value) : \Zend_Gdata_App_FeedEntryParent
\Zend_Gdata_App_Extension_Id
\Zend_Gdata_App_FeedEntryParent
Provides a fluent interfacesetIdentifiers(array $identifiers) : \Zend_Gdata_Books_VolumeEntry
array
identifiers
\Zend_Gdata_Books_VolumeEntry
Provides a fluent interfacesetLanguages(array $languages) : \Zend_Gdata_Books_VolumeEntry
array
languages
\Zend_Gdata_Books_VolumeEntry
Provides a fluent interfacesetLink(array $value) : \Zend_Gdata_App_FeedEntryParent
array
The array of Zend_Gdata_App_Extension_Link elements
\Zend_Gdata_App_FeedEntryParent
Provides a fluent interfacesetMajorProtocolVersion(\(int|\NULL) $value)
setMediaSource(\Zend_Gdata_App_MediaSource $value) : \Zend_Gdata_App_MediaEntry
\Zend_Gdata_App_MediaSource
The attached MediaSource/file
\Zend_Gdata_App_MediaEntry
Provides a fluent interfacesetMinorProtocolVersion(\(int|\NULL) $value)
setPublished(\Zend_Gdata_App_Extension_Published $value) : \Zend_Gdata_App_Entry
\Zend_Gdata_App_Extension_Published
\Zend_Gdata_App_Entry
Provides a fluent interfacesetPublishers(array $publishers) : \Zend_Gdata_Books_VolumeEntry
array
publishers
\Zend_Gdata_Books_VolumeEntry
Provides a fluent interfacesetRating(\Zend_Gdata_Extension_Rating|null $rating) : \Zend_Gdata_Books_VolumeEntry
\Zend_Gdata_Extension_Rating
null
rating
\Zend_Gdata_Books_VolumeEntry
Provides a fluent interfacesetReview(\Zend_Gdata_Books_Extension_Review|null $review) : \Zend_Gdata_Books_VolumeEntry
\Zend_Gdata_Books_Extension_Review
null
review
\Zend_Gdata_Books_VolumeEntry
Provides a fluent interfacesetRights(\Zend_Gdata_App_Extension_Rights $value) : \Zend_Gdata_App_FeedEntryParent
\Zend_Gdata_App_Extension_Rights
\Zend_Gdata_App_FeedEntryParent
Provides a fluent interfacesetService(\Zend_Gdata_App $instance) : \Zend_Gdata_App_FeedEntryParent
\Zend_Gdata_App
The new service instance.
\Zend_Gdata_App_FeedEntryParent
Provides a fluent interface.setSource(\Zend_Gdata_App_Extension_Source $value) : \Zend_Gdata_App_Entry
\Zend_Gdata_App_Extension_Source
\Zend_Gdata_App_Entry
Provides a fluent interfacesetSubjects(array $subjects) : \Zend_Gdata_Books_VolumeEntry
array
subjects
\Zend_Gdata_Books_VolumeEntry
Provides a fluent interfacesetSummary(\Zend_Gdata_App_Extension_Summary $value) : \Zend_Gdata_App_Entry
\Zend_Gdata_App_Extension_Summary
\Zend_Gdata_App_Entry
Provides a fluent interfacesetText(string $value) : \Zend_Gdata_App_Base
string
Child text node
\Zend_Gdata_App_Base
Returns an object of the same type as 'this' to provide a fluent interface.setTitle(\Zend_Gdata_App_Extension_Title $value) : \Zend_Gdata_App_FeedEntryParent
\Zend_Gdata_App_Extension_Title
\Zend_Gdata_App_FeedEntryParent
Provides a fluent interfacesetTitles(array $titles) : \Zend_Gdata_Books_VolumeEntry
array
titles
\Zend_Gdata_Books_VolumeEntry
Provides a fluent interfacesetUpdated(\Zend_Gdata_App_Extension_Updated $value) : \Zend_Gdata_App_FeedEntryParent
\Zend_Gdata_App_Extension_Updated
\Zend_Gdata_App_FeedEntryParent
Provides a fluent interfacesetViewability(\Zend_Gdata_Books_Extension_Viewability|null $viewability) : \Zend_Gdata_Books_VolumeEntry
\Zend_Gdata_Books_Extension_Viewability
null
viewability
\Zend_Gdata_Books_VolumeEntry
Provides a fluent interfacetransferFromDOM(\DOMNode $node)
This is called when XML is received over the wire and the data model needs to be built to represent this XML.
\DOMNode
The DOMNode that represents this object's data
transferFromXML(string $xml)
string
The XML text to parse
takeAttributeFromDOM(\DOMNode $attribute)
\DOMNode
The DOMNode attribute needed to be handled
takeChildFromDOM(\DOMNode $child)
inherited_from | \Zend_Gdata_Entry::takeChildFromDOM() |
---|
\DOMNode
The DOMNode to process.
takeChildFromDOM(\DOMNode $child)
\DOMNode
The DOMNode needed to be handled
$_category
array()
$_content : \Zend_Gdata_App_Extension_Content
null
$_contributor
array()
$_control : \Zend_Gdata_App_Extension_Control
null
$_creators
array()
$_dates
array()
$_descriptions
array()
$_edited : \Zend_Gdata_App_Extension_Edited
null
$_entryClassName : string
'Zend_Gdata_App_Entry'
$_etag : string | null
NULL
$_extensionAttributes : array
array()
$_extensionElements : array
array()
$_formats
array()
$_id
null
$_identifiers
array()
$_languages
array()
$_link
array()
$_majorProtocolVersion
1
$_mediaSource : \Zend_Gdata_App_MediaSource
null
$_minorProtocolVersion
null
$_namespaceLookupCache : array
array()
$_namespaces : array
array('atom' => array(1 => array(0 => 'http://www.w3.org/2005/Atom')), 'app' => array(1 => array(0 => 'http://purl.org/atom/app#'), 2 => array(0 => 'http://www.w3.org/2007/app')))
$_published : \Zend_Gdata_App_Extension_Published
null
$_publishers
array()
$_review
null
$_rights
null
$_rootElement : string
null
$_rootNamespace : string
'atom'
$_rootNamespaceURI : string
null
$_source : \Zend_Gdata_App_Extension_Source
null
$_subjects
array()
$_summary : \Zend_Gdata_App_Extension_Summary
null
$_text : string
null
$_title
null
$_titles
array()
$_updated
null
$_viewability
null
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'
$_comments
Default
null