API Documentation

Gdata/Books/VolumeEntry.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
Books
version
$Id: VolumeEntry.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Gdata_Books_VolumeEntry

Description

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.

Zend_Gdata_Books_VolumeEntry
jump to top

Extends from
Zend_Gdata_Entry
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
Books
Constants
THUMBNAIL_LINK_REL
PREVIEW_LINK_REL
INFO_LINK_REL
ANNOTATION_LINK_REL
Properties
$_comments
$_creators
$_dates
$_descriptions
$_embeddability
$_formats
$_identifiers
$_languages
$_publishers
$_rating
$_review
$_subjects
$_titles
$_viewability
Methods
__construct
getDOM
takeChildFromDOM
getComments
getCreators
getDates
getDescriptions
getEmbeddability
getFormats
getIdentifiers
getLanguages
getPublishers
getRating
getReview
getSubjects
getTitles
getViewability
setComments
setCreators
setDates
setDescriptions
setEmbeddability
setFormats
setIdentifiers
setLanguages
setPublishers
setRating
setReview
setSubjects
setTitles
setViewability
getVolumeId
getThumbnailLink
getPreviewLink
getInfoLink
getAnnotationLink

Description

Describes an entry in a feed of Book Search volumes

Constants

THUMBNAIL_LINK_REL
jump to class

 THUMBNAIL_LINK_REL = 'http://schemas.google.com/books/2008/thumbnail'

Details

value
http://schemas.google.com/books/2008/thumbnail

PREVIEW_LINK_REL
jump to class

 PREVIEW_LINK_REL = 'http://schemas.google.com/books/2008/preview'

Details

value
http://schemas.google.com/books/2008/preview

INFO_LINK_REL
jump to class

 INFO_LINK_REL = 'http://schemas.google.com/books/2008/info'

Details

value
http://schemas.google.com/books/2008/info

ANNOTATION_LINK_REL
jump to class

 ANNOTATION_LINK_REL = 'http://schemas.google.com/books/2008/annotation'

Details

value
http://schemas.google.com/books/2008/annotation

Properties

$_comments
jump to class

 $_comments = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_creators
jump to class

 $_creators = 'array'

Details

visibility
protected
default
array
final
false
static
false

$_dates
jump to class

 $_dates = 'array'

Details

visibility
protected
default
array
final
false
static
false

$_descriptions
jump to class

 $_descriptions = 'array'

Details

visibility
protected
default
array
final
false
static
false

$_embeddability
jump to class

 $_embeddability = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_formats
jump to class

 $_formats = 'array'

Details

visibility
protected
default
array
final
false
static
false

$_identifiers
jump to class

 $_identifiers = 'array'

Details

visibility
protected
default
array
final
false
static
false

$_languages
jump to class

 $_languages = 'array'

Details

visibility
protected
default
array
final
false
static
false

$_publishers
jump to class

 $_publishers = 'array'

Details

visibility
protected
default
array
final
false
static
false

$_rating
jump to class

 $_rating = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_review
jump to class

 $_review = 'null'

Details

visibility
protected
default
null
final
false
static
false

$_subjects
jump to class

 $_subjects = 'array'

Details

visibility
protected
default
array
final
false
static
false

$_titles
jump to class

 $_titles = 'array'

Details

visibility
protected
default
array
final
false
static
false

$_viewability
jump to class

 $_viewability = 'null'

Details

visibility
protected
default
null
final
false
static
false

Methods

__construct
jump to class

__construct( DOMElement $element = null ) :

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

Arguments
$element
DOMElement
(optional) DOMElement from which this object should be constructed.
Details
visibility
public
final
false
static
false

getAnnotationLink
jump to class

getAnnotationLink( ) : Zend_Gdata_App_Extension_Link|null

Gets the annotations link

Output
Zend_Gdata_App_Extension_Link|null
The annotations link
Details
visibility
public
final
false
static
false

getComments
jump to class

getComments( ) : Zend_Gdata_Extension_Comments|null

Returns the Comments class

Output
Zend_Gdata_Extension_Comments|null
The comments
Details
visibility
public
final
false
static
false

getCreators
jump to class

getCreators( ) : array

Returns the creators

Output
array
The creators
Details
visibility
public
final
false
static
false

getDOM
jump to class

getDOM( 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.

Arguments
$doc
DOMDocument
The DOMDocument used to construct DOMElements
$majorVersion
$minorVersion
Output
DOMElement
The DOMElement representing this element and all child properties.
Details
visibility
public
final
false
static
false

getDates
jump to class

getDates( ) : array

Returns the dates

Output
array
The dates
Details
visibility
public
final
false
static
false

getDescriptions
jump to class

getDescriptions( ) : array

Returns the descriptions

Output
array
The descriptions
Details
visibility
public
final
false
static
false

getEmbeddability
jump to class

getEmbeddability( ) : Zend_Gdata_Books_Extension_Embeddability|null

Returns the embeddability

Output
Zend_Gdata_Books_Extension_Embeddability|null
The embeddability
Details
visibility
public
final
false
static
false

getFormats
jump to class

getFormats( ) : array

Returns the formats

Output
array
The formats
Details
visibility
public
final
false
static
false

getIdentifiers
jump to class

getIdentifiers( ) : array

Returns the identifiers

Output
array
The identifiers
Details
visibility
public
final
false
static
false

getInfoLink
jump to class

getInfoLink( ) : Zend_Gdata_App_Extension_Link|null

Gets the info link

Output
Zend_Gdata_App_Extension_Link|null
The info link
Details
visibility
public
final
false
static
false

getLanguages
jump to class

getLanguages( ) : array

Returns the languages

Output
array
The languages
Details
visibility
public
final
false
static
false

getPreviewLink
jump to class

getPreviewLink( ) : Zend_Gdata_App_Extension_Link|null

Gets the preview link

Output
Zend_Gdata_App_Extension_Link|null
The preview link
Details
visibility
public
final
false
static
false

getPublishers
jump to class

getPublishers( ) : array

Returns the publishers

Output
array
The publishers
Details
visibility
public
final
false
static
false

getRating
jump to class

getRating( ) : Zend_Gdata_Extension_Rating|null

Returns the rating

Output
Zend_Gdata_Extension_Rating|null
The rating
Details
visibility
public
final
false
static
false

getReview
jump to class

getReview( ) : Zend_Gdata_Books_Extension_Review|null

Returns the review

Output
Zend_Gdata_Books_Extension_Review|null
The review
Details
visibility
public
final
false
static
false

getSubjects
jump to class

getSubjects( ) : array

Returns the subjects

Output
array
The subjects
Details
visibility
public
final
false
static
false

getThumbnailLink
jump to class

getThumbnailLink( ) : Zend_Gdata_App_Extension_link|null

Gets the thumbnail link

Output
Zend_Gdata_App_Extension_link|null
The thumbnail link
Details
visibility
public
final
false
static
false

getTitles
jump to class

getTitles( ) : array

Returns the titles

Output
array
The titles
Details
visibility
public
final
false
static
false

getViewability
jump to class

getViewability( ) : Zend_Gdata_Books_Extension_Viewability|null

Returns the viewability

Output
Zend_Gdata_Books_Extension_Viewability|null
The viewability
Details
visibility
public
final
false
static
false

getVolumeId
jump to class

getVolumeId( ) : string

Gets the volume ID based upon the atom:id value

Output
string
The volume ID
Details
visibility
public
final
false
static
false
throws

setComments
jump to class

setComments( Zend_Gdata_Extension_Comments|null $comments ) : Zend_Gdata_Books_VolumeEntry

Sets the Comments class

Arguments
$comments
Zend_Gdata_Extension_Commentsnull
Comments class
Output
Zend_Gdata_Books_VolumeEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setCreators
jump to class

setCreators( array $creators ) : Zend_Gdata_Books_VolumeEntry

Sets the creators

Arguments
$creators
array
Creators|null
Output
Zend_Gdata_Books_VolumeEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setDates
jump to class

setDates( array $dates ) : Zend_Gdata_Books_VolumeEntry

Sets the dates

Arguments
$dates
array
dates
Output
Zend_Gdata_Books_VolumeEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setDescriptions
jump to class

setDescriptions( array $descriptions ) : Zend_Gdata_Books_VolumeEntry

Sets the descriptions

Arguments
$descriptions
array
descriptions
Output
Zend_Gdata_Books_VolumeEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setEmbeddability
jump to class

setEmbeddability( Zend_Gdata_Books_Extension_Embeddability|null $embeddability ) : Zend_Gdata_Books_VolumeEntry

Sets the embeddability

Arguments
$embeddability
Zend_Gdata_Books_Extension_Embeddabilitynull
embeddability
Output
Zend_Gdata_Books_VolumeEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setFormats
jump to class

setFormats( array $formats ) : Zend_Gdata_Books_VolumeEntry

Sets the formats

Arguments
$formats
array
formats
Output
Zend_Gdata_Books_VolumeEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setIdentifiers
jump to class

setIdentifiers( array $identifiers ) : Zend_Gdata_Books_VolumeEntry

Sets the identifiers

Arguments
$identifiers
array
identifiers
Output
Zend_Gdata_Books_VolumeEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setLanguages
jump to class

setLanguages( array $languages ) : Zend_Gdata_Books_VolumeEntry

Sets the languages

Arguments
$languages
array
languages
Output
Zend_Gdata_Books_VolumeEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setPublishers
jump to class

setPublishers( array $publishers ) : Zend_Gdata_Books_VolumeEntry

Sets the publishers

Arguments
$publishers
array
publishers
Output
Zend_Gdata_Books_VolumeEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setRating
jump to class

setRating( Zend_Gdata_Extension_Rating|null $rating ) : Zend_Gdata_Books_VolumeEntry

Sets the rating

Arguments
$rating
Zend_Gdata_Extension_Ratingnull
rating
Output
Zend_Gdata_Books_VolumeEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setReview
jump to class

setReview( Zend_Gdata_Books_Extension_Review|null $review ) : Zend_Gdata_Books_VolumeEntry

Sets the review

Arguments
$review
Zend_Gdata_Books_Extension_Reviewnull
review
Output
Zend_Gdata_Books_VolumeEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setSubjects
jump to class

setSubjects( array $subjects ) : Zend_Gdata_Books_VolumeEntry

Sets the subjects

Arguments
$subjects
array
subjects
Output
Zend_Gdata_Books_VolumeEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setTitles
jump to class

setTitles( array $titles ) : Zend_Gdata_Books_VolumeEntry

Sets the titles

Arguments
$titles
array
titles
Output
Zend_Gdata_Books_VolumeEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

setViewability
jump to class

setViewability( Zend_Gdata_Books_Extension_Viewability|null $viewability ) : Zend_Gdata_Books_VolumeEntry

Sets the viewability

Arguments
$viewability
Zend_Gdata_Books_Extension_Viewabilitynull
viewability
Output
Zend_Gdata_Books_VolumeEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

takeChildFromDOM
jump to class

takeChildFromDOM( DOMNode $child ) :

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

Arguments
$child
DOMNode
The DOMNode to process.
Details
visibility
protected
final
false
static
false
Documentation was generated by DocBlox.