## Zend_Gdata_Docs_Query

Description

Assists in constructing queries for Google Document List documents

- copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- link: http://code.google.com/apis/gdata/spreadsheets/
- license: New BSD License

Located in /Gdata/Docs/Query.php (line 40)

    Zend_Gdata_Query
       |
       --Zend_Gdata_Docs_Query

Class Constant Summary
DOCUMENTS_LIST_FEED_URI = 'http://docs.google.com/feeds/documents'
Variable Summary
string $_defaultFeedUri
string $_projection
string $_visibility
Method Summary
Zend_Gdata_Docs_Query __construct ()
string getProjection ()
string getQueryUrl ()
string getTitle ()
string getTitleExact ()
string getVisibility ()
Zend_Gdata_Docs_Query setProjection (string $value)
Zend_Gdata_Docs_Query setTitle (string $value)
Zend_Gdata_Docs_Query setTitleExact (boolean $value)
Zend_Gdata_Docs_Query setVisibility ( $value)
Variables
string $_defaultFeedUri = self::DOCUMENTS_LIST_FEED_URI (line 55)

The generic base URL used by some inherited methods

- access: protected

Redefinition of:

Zend_Gdata_Query::$_defaultFeedUri
  Default URL

string $_projection = 'full' (line 73)

The projection determines how much detail should be given in the result of the query. Full is the only valid projection for the documents list.

- access: protected

string $_visibility = 'private' (line 64)

The visibility to be used when querying for the feed. A request for a feed with private visbility requires the user to be authenricated.

Private is the only avilable visibility for the documents list.

- access: protected

#### Inherited Variables

Inherited from Zend_Gdata_Query

> Zend_Gdata_Query::$_category
> Zend_Gdata_Query::$_params
> Zend_Gdata_Query::$_url

Methods
Constructor __construct (line 78)

Constructs a new instance of a Zend_Gdata_Docs_Query object.

- access: public

Zend_Gdata_Docs_Query __construct ()

Redefinition of:

Zend_Gdata_Query::__construct()
  Create Gdata_Query object

getProjection (line 113)

Gets the projection for this query.

- return: projection
- access: public

string getProjection ()
getQueryUrl (line 198)

Gets the full query URL for this query.

- return: url
- access: public

string getQueryUrl ()

Redefinition of:

Zend_Gdata_Query::getQueryUrl()

getTitle (line 151)

Gets the title attribute for this query.

- return: title
- access: public

string getTitle ()
getTitleExact (line 184)

Gets the title-exact attribute for this query.

- return: title-exact
- access: public

string getTitleExact ()
getVisibility (line 123)

Gets the visibility for this query.

- return: visibility
- access: public

string getVisibility ()
setProjection (line 90)

Sets the projection for this query. Common values for projection include 'full'.

- return: Provides a fluent interface
- access: public

Zend_Gdata_Docs_Query setProjection (string $value)

- string $value

setTitle (line 136)

Sets the title attribute for this query. The title parameter is used to restrict the results to documents whose titles either contain or completely match the title.

- return: Provides a fluent interface
- access: public

Zend_Gdata_Docs_Query setTitle (string $value)

- string $value

setTitleExact (line 169)

Sets the title-exact attribute for this query.

If title-exact is set to true, the title query parameter will be used in an exact match. Only documents with a title identical to the title parameter will be returned.

- return: Provides a fluent interface
- access: public

Zend_Gdata_Docs_Query setTitleExact (boolean $value)

- boolean $value: Use either true or false

setVisibility (line 102)

Sets the visibility for this query. Common values for visibility include 'private'.

- return: Provides a fluent interface
- access: public

Zend_Gdata_Docs_Query setVisibility ( $value)

- $value

#### Inherited Methods

Inherited From Zend_Gdata_Query

> Zend_Gdata_Query::__construct()
> Zend_Gdata_Query::getAlt()
> Zend_Gdata_Query::getAuthor()
> Zend_Gdata_Query::getCategory()
> Zend_Gdata_Query::getMaxResults()
> Zend_Gdata_Query::getParam()
> Zend_Gdata_Query::getPublishedMax()
> Zend_Gdata_Query::getPublishedMin()
> Zend_Gdata_Query::getQuery()
> Zend_Gdata_Query::getQueryString()
> Zend_Gdata_Query::getQueryUrl()
> Zend_Gdata_Query::getStartIndex()
> Zend_Gdata_Query::getUpdatedMax()
> Zend_Gdata_Query::getUpdatedMin()
> Zend_Gdata_Query::resetParameters()
> Zend_Gdata_Query::setAlt()
> Zend_Gdata_Query::setAuthor()
> Zend_Gdata_Query::setCategory()
> Zend_Gdata_Query::setMaxResults()
> Zend_Gdata_Query::setParam()
> Zend_Gdata_Query::setPublishedMax()
> Zend_Gdata_Query::setPublishedMin()
> Zend_Gdata_Query::setQuery()
> Zend_Gdata_Query::setStartIndex()
> Zend_Gdata_Query::setUpdatedMax()
> Zend_Gdata_Query::setUpdatedMin()
> Zend_Gdata_Query::__get()
> Zend_Gdata_Query::__set()

Class Constants
DOCUMENTS_LIST_FEED_URI = 'http://docs.google.com/feeds/documents' (line 48)

The base URL for retrieving a document list

Documentation generated on Tue, 26 Oct 2010 20:09:09 +0400 by phpDocumentor 1.4.2