Gdata/Books/VolumeQuery.php

Show:

inherited

Classes
- \Zend_Gdata_Books_VolumeQuery

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: VolumeQuery.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Gdata_Books_VolumeQuery
jump to top

Package: Zend\Gdata\Books

Assists in constructing queries for Books volumes

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

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

Properties

string $_category = null

inherited

Category for the query

Inherited from: \Zend_Gdata_Query::$$_category

Default valuenullDetails

Type: string
Inherited_from: \Zend_Gdata_Query::$$_category

string $_defaultFeedUri = null

inherited

Default URL

Inherited from: \Zend_Gdata_Query::$$_defaultFeedUri

Default valuenullDetails

Type: string
Inherited_from: \Zend_Gdata_Query::$$_defaultFeedUri

array $_params = array()

inherited

Query parameters.

Inherited from: \Zend_Gdata_Query::$$_params

Default valuearray()Details

Type: array
Inherited_from: \Zend_Gdata_Query::$$_params

string $_url = null

inherited

Base URL TODO: Add setters and getters

Inherited from: \Zend_Gdata_Query::$$_url

Default valuenullDetails

Type: string
Inherited_from: \Zend_Gdata_Query::$$_url

Methods

__construct(string | null $url = null) : void

Create Gdata_Books_VolumeQuery object

Parameters

Name	Type	Description
$url	string \| null	If non-null, pre-initializes the instance to use a given URL.

__get( $name) : void

inherited

Inherited from: \Zend_Gdata_Query::__get()

Parameters

Name	Type	Description
$name

__set( $name, $val) : void

inherited

Inherited from: \Zend_Gdata_Query::__set()

Parameters

Name	Type	Description
$name
$val

getAlt() : string

inherited

Inherited from: \Zend_Gdata_Query::getAlt()

Returns

Type	Description
string	rss or atom

getAuthor() : string

inherited

Inherited from: \Zend_Gdata_Query::getAuthor()

Returns

Type	Description
string	author

getCategory() : void

inherited

Inherited from: \Zend_Gdata_Query::getCategory()

getMaxResults() : int

inherited

Inherited from: \Zend_Gdata_Query::getMaxResults()

Returns

Type	Description
int	maxResults

getMinViewability() : string | null

Minimum viewability of volumes to include in search results

Returns

Type	Description
string \| null	min-viewability

getParam(string $name) : void

inherited

Inherited from: \Zend_Gdata_Query::getParam()

Parameters

Name	Type	Description
$name	string

getPublishedMax() : string

inherited

Inherited from: \Zend_Gdata_Query::getPublishedMax()

Returns

Type	Description
string	publishedMax

getPublishedMin() : string

inherited

Inherited from: \Zend_Gdata_Query::getPublishedMin()

Returns

Type	Description
string	publishedMin

getQuery() : string

inherited

Inherited from: \Zend_Gdata_Query::getQuery()

Returns

Type	Description
string	query

getQueryString() : string

inherited

Inherited from: \Zend_Gdata_Query::getQueryString()

Returns

Type	Description
string	querystring

getQueryUrl() : string

Returns the generated full query URL

Returns

Type	Description
string	The URL

getStartIndex() : int

inherited

Inherited from: \Zend_Gdata_Query::getStartIndex()

Returns

Type	Description
int	startIndex

getUpdatedMax() : string

inherited

Inherited from: \Zend_Gdata_Query::getUpdatedMax()

Returns

Type	Description
string	updatedMax

getUpdatedMin() : string

inherited

Inherited from: \Zend_Gdata_Query::getUpdatedMin()

Returns

Type	Description
string	updatedMin

resetParameters() : void

inherited

Inherited from: \Zend_Gdata_Query::resetParameters()

setAlt(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setAlt()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setAuthor(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setAuthor()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setCategory(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setCategory()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setMaxResults(int $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setMaxResults()

Parameters

Name	Type	Description
$value	int

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

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

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

Parameters

Name	Type	Description
$value	string \| null	The minimum viewability - 'full' or 'partial'

Returns

Type	Description
\Zend_Gdata_Books_VolumeQuery	Provides a fluent interface

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

inherited

Inherited from: \Zend_Gdata_Query::setParam()

Parameters

Name	Type	Description
$name	string
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setPublishedMax(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setPublishedMax()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setPublishedMin(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setPublishedMin()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setQuery(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setQuery()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setStartIndex(int $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setStartIndex()

Parameters

Name	Type	Description
$value	int

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setUpdatedMax(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setUpdatedMax()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

setUpdatedMin(string $value) : \Zend_Gdata_Query

inherited

Inherited from: \Zend_Gdata_Query::setUpdatedMin()

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Query	Provides a fluent interface

Gdata/Books/VolumeQuery.php

\Zend_Gdata_Books_VolumeQueryjump to top

Properties

Methods

\Zend_Gdata_Books_VolumeQuery
jump to top