API Documentation

Zend/Gdata/Books/VolumeEntry.php

Show: inherited
Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Gdata  
Subpackage
Books  
Version
$Id: VolumeEntry.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Gdata_Books_VolumeEntry

Package: Zend\Gdata\Books

Describes an entry in a feed of Book Search volumes

Parent(s)
\Zend_Gdata_Entry < \Zend_Gdata_App_MediaEntry < \Zend_Gdata_App_Entry < \Zend_Gdata_App_FeedEntryParent < \Zend_Gdata_App_Base
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

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

Properties

Propertyprotected  $_comments= 'null'
Default valuenullDetails
Type
Propertyprotected  $_creators= 'array()'
Default valuearray()Details
Type
Propertyprotected  $_dates= 'array()'
Default valuearray()Details
Type
Propertyprotected  $_descriptions= 'array()'
Default valuearray()Details
Type
Propertyprotected  $_embeddability= 'null'
Default valuenullDetails
Type
Propertyprotected  $_formats= 'array()'
Default valuearray()Details
Type
Propertyprotected  $_identifiers= 'array()'
Default valuearray()Details
Type
Propertyprotected  $_languages= 'array()'
Default valuearray()Details
Type
Propertyprotected  $_publishers= 'array()'
Default valuearray()Details
Type
Propertyprotected  $_rating= 'null'
Default valuenullDetails
Type
Propertyprotected  $_review= 'null'
Default valuenullDetails
Type
Propertyprotected  $_subjects= 'array()'
Default valuearray()Details
Type
Propertyprotected  $_titles= 'array()'
Default valuearray()Details
Type
Propertyprotected  $_viewability= 'null'
Default valuenullDetails
Type

Methods

methodpublic__construct( \DOMElement $element = null ) : void

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

Parameters
Name Type Description
$element \DOMElement

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

methodpublicgetAnnotationLink( ) : \Zend_Gdata_App_Extension_Link|null

Gets the annotations link

Returns
Type Description
\Zend_Gdata_App_Extension_Link|null The annotations link
methodpublicgetComments( ) : \Zend_Gdata_Extension_Comments|null

Returns the Comments class

Returns
Type Description
\Zend_Gdata_Extension_Comments|null The comments
methodpublicgetCreators( ) : array

Returns the creators

Returns
Type Description
array The creators
methodpublicgetDOM( \DOMDocument $doc = null,  $majorVersion = 1,  $minorVersion = null ) : \DOMElement

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
Name Type Description
$doc \DOMDocument

The DOMDocument used to construct DOMElements

$majorVersion
$minorVersion
Returns
Type Description
\DOMElement The DOMElement representing this element and all child properties.
methodpublicgetDates( ) : array

Returns the dates

Returns
Type Description
array The dates
methodpublicgetDescriptions( ) : array

Returns the descriptions

Returns
Type Description
array The descriptions
methodpublicgetEmbeddability( ) : \Zend_Gdata_Books_Extension_Embeddability|null

Returns the embeddability

Returns
Type Description
\Zend_Gdata_Books_Extension_Embeddability|null The embeddability
methodpublicgetFormats( ) : array

Returns the formats

Returns
Type Description
array The formats
methodpublicgetIdentifiers( ) : array

Returns the identifiers

Returns
Type Description
array The identifiers
methodpublicgetInfoLink( ) : \Zend_Gdata_App_Extension_Link|null

Gets the info link

Returns
Type Description
\Zend_Gdata_App_Extension_Link|null The info link
methodpublicgetLanguages( ) : array

Returns the languages

Returns
Type Description
array The languages
methodpublicgetPreviewLink( ) : \Zend_Gdata_App_Extension_Link|null

Gets the preview link

Returns
Type Description
\Zend_Gdata_App_Extension_Link|null The preview link
methodpublicgetPublishers( ) : array

Returns the publishers

Returns
Type Description
array The publishers
methodpublicgetRating( ) : \Zend_Gdata_Extension_Rating|null

Returns the rating

Returns
Type Description
\Zend_Gdata_Extension_Rating|null The rating
methodpublicgetReview( ) : \Zend_Gdata_Books_Extension_Review|null

Returns the review

Returns
Type Description
\Zend_Gdata_Books_Extension_Review|null The review
methodpublicgetSubjects( ) : array

Returns the subjects

Returns
Type Description
array The subjects
methodpublicgetThumbnailLink( ) : \Zend_Gdata_App_Extension_link|null

Gets the thumbnail link

Returns
Type Description
\Zend_Gdata_App_Extension_link|null The thumbnail link
methodpublicgetTitles( ) : array

Returns the titles

Returns
Type Description
array The titles
methodpublicgetViewability( ) : \Zend_Gdata_Books_Extension_Viewability|null

Returns the viewability

Returns
Type Description
\Zend_Gdata_Books_Extension_Viewability|null The viewability
methodpublicgetVolumeId( ) : string

Gets the volume ID based upon the atom:id value

Returns
Type Description
string The volume ID
Throws
Exception Description
\Zend_Gdata_App_Exception
methodpublicsetComments( \Zend_Gdata_Extension_Comments|null $comments ) : \Zend_Gdata_Books_VolumeEntry

Sets the Comments class

Parameters
Name Type Description
$comments \Zend_Gdata_Extension_Comments|null

Comments class

Returns
Type Description
\Zend_Gdata_Books_VolumeEntry Provides a fluent interface
methodpublicsetCreators( array $creators ) : \Zend_Gdata_Books_VolumeEntry

Sets the creators

Parameters
Name Type Description
$creators array

Creators|null

Returns
Type Description
\Zend_Gdata_Books_VolumeEntry Provides a fluent interface
methodpublicsetDates( array $dates ) : \Zend_Gdata_Books_VolumeEntry

Sets the dates

Parameters
Name Type Description
$dates array

dates

Returns
Type Description
\Zend_Gdata_Books_VolumeEntry Provides a fluent interface
methodpublicsetDescriptions( array $descriptions ) : \Zend_Gdata_Books_VolumeEntry

Sets the descriptions

Parameters
Name Type Description
$descriptions array

descriptions

Returns
Type Description
\Zend_Gdata_Books_VolumeEntry Provides a fluent interface
methodpublicsetEmbeddability( \Zend_Gdata_Books_Extension_Embeddability|null $embeddability ) : \Zend_Gdata_Books_VolumeEntry

Sets the embeddability

Parameters
Name Type Description
$embeddability \Zend_Gdata_Books_Extension_Embeddability|null

embeddability

Returns
Type Description
\Zend_Gdata_Books_VolumeEntry Provides a fluent interface
methodpublicsetFormats( array $formats ) : \Zend_Gdata_Books_VolumeEntry

Sets the formats

Parameters
Name Type Description
$formats array

formats

Returns
Type Description
\Zend_Gdata_Books_VolumeEntry Provides a fluent interface
methodpublicsetIdentifiers( array $identifiers ) : \Zend_Gdata_Books_VolumeEntry

Sets the identifiers

Parameters
Name Type Description
$identifiers array

identifiers

Returns
Type Description
\Zend_Gdata_Books_VolumeEntry Provides a fluent interface
methodpublicsetLanguages( array $languages ) : \Zend_Gdata_Books_VolumeEntry

Sets the languages

Parameters
Name Type Description
$languages array

languages

Returns
Type Description
\Zend_Gdata_Books_VolumeEntry Provides a fluent interface
methodpublicsetPublishers( array $publishers ) : \Zend_Gdata_Books_VolumeEntry

Sets the publishers

Parameters
Name Type Description
$publishers array

publishers

Returns
Type Description
\Zend_Gdata_Books_VolumeEntry Provides a fluent interface
methodpublicsetRating( \Zend_Gdata_Extension_Rating|null $rating ) : \Zend_Gdata_Books_VolumeEntry

Sets the rating

Parameters
Name Type Description
$rating \Zend_Gdata_Extension_Rating|null

rating

Returns
Type Description
\Zend_Gdata_Books_VolumeEntry Provides a fluent interface
methodpublicsetReview( \Zend_Gdata_Books_Extension_Review|null $review ) : \Zend_Gdata_Books_VolumeEntry

Sets the review

Parameters
Name Type Description
$review \Zend_Gdata_Books_Extension_Review|null

review

Returns
Type Description
\Zend_Gdata_Books_VolumeEntry Provides a fluent interface
methodpublicsetSubjects( array $subjects ) : \Zend_Gdata_Books_VolumeEntry

Sets the subjects

Parameters
Name Type Description
$subjects array

subjects

Returns
Type Description
\Zend_Gdata_Books_VolumeEntry Provides a fluent interface
methodpublicsetTitles( array $titles ) : \Zend_Gdata_Books_VolumeEntry

Sets the titles

Parameters
Name Type Description
$titles array

titles

Returns
Type Description
\Zend_Gdata_Books_VolumeEntry Provides a fluent interface
methodpublicsetViewability( \Zend_Gdata_Books_Extension_Viewability|null $viewability ) : \Zend_Gdata_Books_VolumeEntry

Sets the viewability

Parameters
Name Type Description
$viewability \Zend_Gdata_Books_Extension_Viewability|null

viewability

Returns
Type Description
\Zend_Gdata_Books_VolumeEntry Provides a fluent interface
methodprotectedtakeChildFromDOM( \DOMNode $child ) : void

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

Parameters
Name Type Description
$child \DOMNode

The DOMNode to process.

Documentation was generated by DocBlox 0.15.1.