Gdata/Spreadsheets/DocumentQuery.php

Show:

inherited

Classes
- \Zend_Gdata_Spreadsheets_DocumentQuery

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

\Zend_Gdata_Spreadsheets_DocumentQuery
jump to top

Package: Zend\Gdata\Spreadsheets

Assists in constructing queries for Google Spreadsheets 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

 
                SPREADSHEETS_FEED_URI
                = 'https://spreadsheets.google.com/feeds'

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::SPREADSHEETS_FEED_URI

Default URL

Default valueself::SPREADSHEETS_FEED_URIDetails

Type: string

$_documentType

Details

Type: n/a

array $_params = array()

inherited

Query parameters.

Inherited from: \Zend_Gdata_Query::$$_params

Default valuearray()Details

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

$_projection = 'full'

Default value'full'Details

Type: n/a

$_spreadsheetKey = null

Default valuenullDetails

Type: n/a

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

$_visibility = 'private'

Default value'private'Details

Type: n/a

$_worksheetId = null

Default valuenullDetails

Type: n/a

Methods

__construct() : void

Constructs a new Zend_Gdata_Spreadsheets_DocumentQuery 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

appendVisibilityProjection() : void

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()

getDocumentType() : string

Gets the document type for this query.

Returns

Type	Description
string	document type

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

Gets the attribute query string for this query.

Returns

Type	Description
string	query string

getQueryUrl() : string

Gets the full query URL for this query.

Returns

Type	Description
string	url

getSpreadsheetKey() : string

Gets the spreadsheet key for this query.

Returns

Type	Description
string	spreadsheet key

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

getWorksheetId() : string

Gets the worksheet id for this query.

Returns

Type	Description
string	worksheet id

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

setDocumentType(string $value) : \Zend_Gdata_Spreadsheets_DocumentQuery

Sets the document type for this query.

Parameters

Name	Type	Description
$value	string	spreadsheets or worksheets

Returns

Type	Description
\Zend_Gdata_Spreadsheets_DocumentQuery	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_Spreadsheets_DocumentQuery

Sets the projection for this query.

Parameters

Name	Type	Description
$value	string

Returns

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

setSpreadsheetKey(string $value) : \Zend_Gdata_Spreadsheets_CellQuery

Sets the spreadsheet key for this query.

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Spreadsheets_CellQuery	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_Spreadsheets_DocumentQuery

Sets the title attribute for this query.

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Spreadsheets_DocumentQuery	Provides a fluent interface

setTitleExact(string $value) : \Zend_Gdata_Spreadsheets_DocumentQuery

Sets the title-exact attribute for this query.

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Spreadsheets_DocumentQuery	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_Spreadsheets_DocumentQuery

Sets the visibility for this query.

Parameters

Name	Type	Description
$value

Returns

Type	Description
\Zend_Gdata_Spreadsheets_DocumentQuery	Provides a fluent interface

setWorksheetId(string $value) : \Zend_Gdata_Spreadsheets_CellQuery

Sets the worksheet id for this query.

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Gdata_Spreadsheets_CellQuery	Provides a fluent interface

Gdata/Spreadsheets/DocumentQuery.php

\Zend_Gdata_Spreadsheets_DocumentQueryjump to top

Constants

Properties

Methods

\Zend_Gdata_Spreadsheets_DocumentQuery
jump to top