Zend/Gdata/Docs/Query.php
Show:
inherited
inherited
Classes
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
- Docs
- Version
- $Id: Query.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Gdata_Docs_Query
Package: Zend\Gdata\Docs
Default value
Default value
Default value
Returns
Returns
Returns
Returns
Returns
Parameters
Returns
Parameters
Returns
Parameters
Returns
Parameters
Returns
Assists in constructing queries for Google Document List documents
- 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
$_defaultFeedUri= 'self::DOCUMENTS_LIST_FEED_URI'
The generic base URL used by some inherited methods
self::DOCUMENTS_LIST_FEED_URIDetails- Type
- string
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.
'full'Details- Type
- string
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.
'private'Details- Type
- string
Methods
__construct(
)
:
voidConstructs a new instance of a Zend_Gdata_Docs_Query object.
getProjection(
)
:
stringGets the projection for this query.
| Type | Description |
|---|---|
| string | projection |
getQueryUrl(
)
:
stringGets the full query URL for this query.
| Type | Description |
|---|---|
| string | url |
getTitle(
)
:
stringGets the title attribute for this query.
| Type | Description |
|---|---|
| string | title |
getTitleExact(
)
:
stringGets the title-exact attribute for this query.
| Type | Description |
|---|---|
| string | title-exact |
getVisibility(
)
:
stringGets the visibility for this query.
| Type | Description |
|---|---|
| string | visibility |
setProjection(
string $value
)
:
\Zend_Gdata_Docs_QuerySets the projection for this query. Common values for projection include 'full'.
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Gdata_Docs_Query | Provides a fluent interface |
setTitle(
string $value
)
:
\Zend_Gdata_Docs_QuerySets 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.
| Name | Type | Description |
|---|---|---|
| $value | string |
| Type | Description |
|---|---|
| \Zend_Gdata_Docs_Query | Provides a fluent interface |
setTitleExact(
boolean $value
)
:
\Zend_Gdata_Docs_QuerySets 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.
| Name | Type | Description |
|---|---|---|
| $value | boolean | Use either true or false |
| Type | Description |
|---|---|
| \Zend_Gdata_Docs_Query | Provides a fluent interface |
setVisibility(
$value
)
:
\Zend_Gdata_Docs_QuerySets the visibility for this query. Common values for visibility include 'private'.
| Name | Type | Description |
|---|---|---|
| $value |
| Type | Description |
|---|---|
| \Zend_Gdata_Docs_Query | Provides a fluent interface |