Zend Framework API Documentation
Back to top  

Assists in constructing queries for Books volumes

Queries are not defined for APP, but are provided by Gdata services as an extension.

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_Query

 Methods

Create Gdata_Books_VolumeQuery object

__construct(string|null $url = null) 
inherited_from \Zend_Gdata_Query::__construct()

Parameters

$url

stringnull

If non-null, pre-initializes the instance to use a given URL.

Create Gdata_Query object

__construct($url = null) 
Inherited

Parameters

$url

__get() 

__get($name) 
Inherited

Parameters

$name

__set() 

__set($name, $val) 
Inherited

Parameters

$name

$val

getAlt() 

getAlt() : string
Inherited

Returns

stringrss or atom

getAuthor() 

getAuthor() : string
Inherited

Returns

stringauthor

getCategory() 

getCategory() 
Inherited

getMaxResults() 

getMaxResults() : integer
Inherited

Returns

integermaxResults

Minimum viewability of volumes to include in search results

getMinViewability() : string | null

Returns

stringnullmin-viewability

getParam() 

getParam(string $name) 
Inherited

Parameters

$name

string

getPublishedMax() 

getPublishedMax() : string
Inherited

Returns

stringpublishedMax

getPublishedMin() 

getPublishedMin() : string
Inherited

Returns

stringpublishedMin

getQuery() 

getQuery() : string
Inherited

Returns

stringquery

getQueryString() 

getQueryString() : string
Inherited

Returns

stringquerystring

Returns the generated full query URL

getQueryUrl() : string
inherited_from \Zend_Gdata_Query::getQueryUrl()

Returns

stringThe URL

getQueryUrl() 

getQueryUrl() : string
Inherited

Returns

stringurl

getStartIndex() 

getStartIndex() : integer
Inherited

Returns

integerstartIndex

getUpdatedMax() 

getUpdatedMax() : string
Inherited

Returns

stringupdatedMax

getUpdatedMin() 

getUpdatedMin() : string
Inherited

Returns

stringupdatedMin

resetParameters() 

resetParameters() 
Inherited

setAlt() 

setAlt(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setAuthor() 

setAuthor(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setCategory() 

setCategory(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setMaxResults() 

setMaxResults(integer $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

integer

Returns

\Zend_Gdata_QueryProvides a fluent interface

Sets the minimum level of viewability of volumes to return in the search results

setMinViewability(string|null $value = null) : \Zend_Gdata_Books_VolumeQuery

Parameters

$value

stringnull

The minimum viewability - 'full' or 'partial'

Returns

\Zend_Gdata_Books_VolumeQueryProvides a fluent interface

setParam() 

setParam(string $name, string $value) : \Zend_Gdata_Query
Inherited

Parameters

$name

string

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setPublishedMax() 

setPublishedMax(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setPublishedMin() 

setPublishedMin(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setQuery() 

setQuery(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setStartIndex() 

setStartIndex(integer $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

integer

Returns

\Zend_Gdata_QueryProvides a fluent interface

setUpdatedMax() 

setUpdatedMax(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setUpdatedMin() 

setUpdatedMin(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

 Properties

 

Category for the query

$_category : string

Default

null
 

Default URL

$_defaultFeedUri : string

Default

null
 

Query parameters.

$_params : array

Default

array()
 

Base URL TODO: Add setters and getters

$_url : string

Default

null