Gdata/Books.php

Show:

inherited

Classes
- \Zend_Gdata_Books

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 [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Gdata
Subpackage: Books
Version: $Id$

\Zend_Gdata_Books
jump to top

Package: Zend_Gdata\Books

Service class for interacting with the Books service

As the Google data API protocol is based upon the Atom Publishing Protocol (APP), Gdata functionality extends the appropriate Zend_Gdata_App classes

Parent(s): \Zend_Gdata < \Zend_Gdata_App
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                VOLUME_FEED_URI
                = 'https://books.google.com/books/feeds/volumes'

 
                MY_LIBRARY_FEED_URI
                = 'https://books.google.com/books/feeds/users/me/collections/library/volumes'

 
                MY_ANNOTATION_FEED_URI
                = 'https://books.google.com/books/feeds/users/me/volumes'

 
                AUTH_SERVICE_NAME
                = 'print'

Properties

array $namespaces = array(array('gbs', 'http://schemas.google.com/books/2008', 1, 0), array('dc', 'http://purl.org/dc/terms', 1, 0))

static

Namespaces used for Zend_Gdata_Books

Default valuearray(array('gbs', 'http://schemas.google.com/books/2008', 1, 0), array('dc', 'http://purl.org/dc/terms', 1, 0))Details

Type: array

Methods

__construct(\Zend_Http_Client $client = null, string $applicationId = 'MyCompany-MyApp-1.0') : void

Create Zend_Gdata_Books object

Parameters

Name	Type	Description
$client	\Zend_Http_Client	(optional) The HTTP client to use when `when communicating with the Google servers.`
$applicationId	string	The identity of the app in the form of Company-AppName-Version

deleteVolume(\Zend_Gdata_Books_VolumeEntry $entry) : void

Delete a Volume

Parameters

Name	Type	Description
$entry	\Zend_Gdata_Books_VolumeEntry

getUserAnnotationFeed(\Zend_Gdata_Query | string | null $location = null) : \Zend_Gdata_Books_VolumeFeed

Retrieves a feed of volumes, by default the User annotation feed

Parameters

Name	Type	Description
$location	\Zend_Gdata_Query \| string \| null	(optional) The URL to `query.`

Returns

Type	Description
\Zend_Gdata_Books_VolumeFeed	The feed of volumes found at the specified URL.

getUserLibraryFeed(\Zend_Gdata_Query | string | null $location = null) : \Zend_Gdata_Books_VolumeFeed

Retrieves a feed of volumes, by default the User library feed.

Parameters

Name	Type	Description
$location	\Zend_Gdata_Query \| string \| null	(optional) The URL to `query.`

Returns

Type	Description
\Zend_Gdata_Books_VolumeFeed	The feed of volumes found at the specified URL.

getVolumeEntry(string | null $volumeId = null, \Zend_Gdata_Query | string | null $location = null) : \Zend_Gdata_Books_VolumeEntry

Retrieves a specific volume entry.

Parameters

Name	Type	Description
$volumeId	string \| null	The volumeId of interest.
$location	\Zend_Gdata_Query \| string \| null	(optional) The URL to `query or a Zend_Gdata_Query object from which a URL can be determined.`

Returns

Type	Description
\Zend_Gdata_Books_VolumeEntry	The feed of volumes found at the specified URL.

getVolumeFeed(\Zend_Gdata_Query | string | null $location = null) : \Zend_Gdata_Books_VolumeFeed

Retrieves a feed of volumes.

Parameters

Name	Type	Description
$location	\Zend_Gdata_Query \| string \| null	(optional) The URL to `query or a Zend_Gdata_Query object from which a URL can be determined.`

Returns

Type	Description
\Zend_Gdata_Books_VolumeFeed	The feed of volumes found at the specified URL.

insertVolume(\Zend_Gdata_Books_VolumeEntry $entry, \Zend_Gdata_Query | string | null $location = null) : \Zend_Gdata_Books_VolumeEntry

Insert a Volume / Annotation

Parameters

Name	Type	Description
$entry	\Zend_Gdata_Books_VolumeEntry
$location	\Zend_Gdata_Query \| string \| null	(optional) The URL to `query`

Returns

Type	Description
\Zend_Gdata_Books_VolumeEntry	The inserted volume entry.

Gdata/Books.php

\Zend_Gdata_Booksjump to top

Constants

Properties

Methods

\Zend_Gdata_Books
jump to top