Gdata/Docs/Query.php

Show:

inherited

Classes
- \Zend_Gdata_Docs_Query

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-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Gdata
Subpackage: Docs
Version: $Id: Query.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Gdata_Docs_Query
jump to top

Package: Zend\Gdata\Docs

Assists in constructing queries for Google Document List documents

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
Link: http://code.google.com/apis/gdata/spreadsheets/

Constants

string 
                DOCUMENTS_LIST_FEED_URI
                = 'https://docs.google.com/feeds/documents'

The base URL for retrieving a document list

: string

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 = self::DOCUMENTS_LIST_FEED_URI

The generic base URL used by some inherited methods

Default valueself::DOCUMENTS_LIST_FEED_URIDetails

Type: string

array $_params = array()

inherited

Query parameters.

Inherited from: \Zend_Gdata_Query::$$_params

Default valuearray()Details

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

string $_projection = 'full'

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.

Default value'full'Details

Type: string

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

string $_visibility = 'private'

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.

Default value'private'Details

Type: string

Methods

__construct() : void

Constructs a new instance of a Zend_Gdata_Docs_Query object.

__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

getParam(string $name) : void

inherited

Inherited from: \Zend_Gdata_Query::getParam()

Parameters

Name	Type	Description
$name	string

getProjection() : string

Gets the projection for this query.

Returns

Type	Description
string	projection

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

Gets the full query URL for this query.

Returns

Type	Description
string	url

getStartIndex() : int

inherited

Inherited from: \Zend_Gdata_Query::getStartIndex()

Returns

Type	Description
int	startIndex

getTitle() : string

Gets the title attribute for this query.

Returns

Type	Description
string	title

getTitleExact() : string

Gets the title-exact attribute for this query.

Returns

Type	Description
string	title-exact

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

getVisibility() : string

Gets the visibility for this query.

Returns

Type	Description
string	visibility

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

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

setProjection(string $value) : \Zend_Gdata_Docs_Query

Sets the projection for this query.

Common values for projection include 'full'.

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Docs_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

setTitle(string $value) : \Zend_Gdata_Docs_Query

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.

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Docs_Query	Provides a fluent interface

setTitleExact(boolean $value) : \Zend_Gdata_Docs_Query

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.

Parameters

Name	Type	Description
$value	boolean	Use either true or false

Returns

Type	Description
\Zend_Gdata_Docs_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

setVisibility( $value) : \Zend_Gdata_Docs_Query

Sets the visibility for this query.

Common values for visibility include 'private'.

Parameters

Name	Type	Description
$value

Returns

Type	Description
\Zend_Gdata_Docs_Query	Provides a fluent interface

Gdata/Docs/Query.php

\Zend_Gdata_Docs_Queryjump to top

Constants

Properties

Methods

\Zend_Gdata_Docs_Query
jump to top