Gdata/Books.php
- 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: Books.php 20096 2010-01-06 02:05:09Z bkarwin $
- Classes
- Zend_Gdata_Books
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
- Extends from
- Zend_Gdata
- 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
- VOLUME_FEED_URI
- MY_LIBRARY_FEED_URI
- MY_ANNOTATION_FEED_URI
- AUTH_SERVICE_NAME
- Properties
- $namespaces
- Methods
- __construct
- getVolumeFeed
- getVolumeEntry
- getUserLibraryFeed
- getUserAnnotationFeed
- insertVolume
- deleteVolume
Description
Service class for interacting with the Books service
Constants
VOLUME_FEED_URI
VOLUME_FEED_URI = 'http://books.google.com/books/feeds/volumes'
Details
- value
- http://books.google.com/books/feeds/volumes
MY_LIBRARY_FEED_URI
MY_LIBRARY_FEED_URI = 'http://books.google.com/books/feeds/users/me/collections/library/volumes'
Details
- value
- http://books.google.com/books/feeds/users/me/collections/library/volumes
MY_ANNOTATION_FEED_URI
MY_ANNOTATION_FEED_URI = 'http://books.google.com/books/feeds/users/me/volumes'
Details
- value
- http://books.google.com/books/feeds/users/me/volumes
AUTH_SERVICE_NAME
AUTH_SERVICE_NAME = 'print'
Details
- value
Properties
$namespaces
array $namespaces = 'array'Namespaces used for Zend_Gdata_Books
Details
- $namespaces
- array
- visibility
- public
- default
- array
- final
- false
- static
- true
Methods
__construct
__construct(
Zend_Http_Client $client
=
null, string $applicationId
=
MyCompany-MyApp-1.0
)
:
Create Zend_Gdata_Books object
Arguments
- $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
Details
- visibility
- public
- final
- false
- static
- false
deleteVolume
deleteVolume(
Zend_Gdata_Books_VolumeEntry $entry
)
:
voidDelete a Volume
Arguments
- $entry
- Zend_Gdata_Books_VolumeEntry
Details
- visibility
- public
- final
- false
- static
- false
getUserAnnotationFeed
getUserAnnotationFeed(
Zend_Gdata_Query|string|null $location
=
null
)
:
Zend_Gdata_Books_VolumeFeedRetrieves a feed of volumes, by default the User annotation feed
Arguments
- $location
- Zend_Gdata_Querystringnull
(optional) The URL to query.
Output
- Zend_Gdata_Books_VolumeFeed
- The feed of volumes found at the specified URL.
Details
- visibility
- public
- final
- false
- static
- false
getUserLibraryFeed
getUserLibraryFeed(
Zend_Gdata_Query|string|null $location
=
null
)
:
Zend_Gdata_Books_VolumeFeedRetrieves a feed of volumes, by default the User library feed.
Arguments
- $location
- Zend_Gdata_Querystringnull
(optional) The URL to query.
Output
- Zend_Gdata_Books_VolumeFeed
- The feed of volumes found at the specified URL.
Details
- visibility
- public
- final
- false
- static
- false
getVolumeEntry
getVolumeEntry(
string|null $volumeId
=
null, Zend_Gdata_Query|string|null $location
=
null
)
:
Zend_Gdata_Books_VolumeEntryRetrieves a specific volume entry.
Arguments
- $volumeId
- stringnull
The volumeId of interest. - $location
- Zend_Gdata_Querystringnull
(optional) The URL to query or a Zend_Gdata_Query object from which a URL can be determined.
Output
- Zend_Gdata_Books_VolumeEntry
- The feed of volumes found at the specified URL.
Details
- visibility
- public
- final
- false
- static
- false
getVolumeFeed
getVolumeFeed(
Zend_Gdata_Query|string|null $location
=
null
)
:
Zend_Gdata_Books_VolumeFeedRetrieves a feed of volumes.
Arguments
- $location
- Zend_Gdata_Querystringnull
(optional) The URL to query or a Zend_Gdata_Query object from which a URL can be determined.
Output
- Zend_Gdata_Books_VolumeFeed
- The feed of volumes found at the specified URL.
Details
- visibility
- public
- final
- false
- static
- false
insertVolume
insertVolume(
Zend_Gdata_Books_VolumeEntry $entry, Zend_Gdata_Query|string|null $location
=
null
)
:
Zend_Gdata_Books_VolumeEntryInsert a Volume / Annotation
Arguments
- $entry
- Zend_Gdata_Books_VolumeEntry
- $location
- Zend_Gdata_Querystringnull
(optional) The URL to query
Output
- Zend_Gdata_Books_VolumeEntry
- The inserted volume entry.
Details
- visibility
- public
- final
- false
- static
- false