API Documentation

Gdata/Docs/Query.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Gdata  
subpackage
Docs  
version
$Id: Query.php 23805 2011-03-16 00:55:40Z tjohns $  

\Zend_Gdata_Docs_Query

Assists in constructing queries for Google Document List documents

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

Extends from
\Zend_Gdata_Query
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
link
http://code.google.com/apis/gdata/spreadsheets/  
package
Zend_Gdata  
subpackage
Docs  

Constants

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

The base URL for retrieving a document list

string

Properties

Propertyprotectedstring  $_defaultFeedUri= 'self'

The generic base URL used by some inherited methods

Default valueselfDetails
Type
string
Propertyprotectedstring  $_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 valuefullDetails
Type
string
Propertyprotectedstring  $_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 valueprivateDetails
Type
string

Methods

methodpublic__construct( ) : void

Constructs a new instance of a Zend_Gdata_Docs_Query object.

methodpublic__get(  $name ) : void

Inherited from: \Zend_Gdata_Query::__get()
Parameters
Name Type Description
$name
methodpublic__set(  $name,  $val ) : void

Inherited from: \Zend_Gdata_Query::__set()
Parameters
Name Type Description
$name
$val
methodpublicgetAlt( ) : string

Inherited from: \Zend_Gdata_Query::getAlt()
Returns
Type Description
string rss or atom
methodpublicgetAuthor( ) : string
Returns
Type Description
string author
methodpublicgetCategory( ) : void
methodpublicgetMaxResults( ) : int
Returns
Type Description
int maxResults
methodpublicgetParam( string $name ) : void
Parameters
Name Type Description
$name string
methodpublicgetProjection( ) : string

Gets the projection for this query.

Returns
Type Description
string projection
methodpublicgetPublishedMax( ) : string
Returns
Type Description
string publishedMax
methodpublicgetPublishedMin( ) : string
Returns
Type Description
string publishedMin
methodpublicgetQuery( ) : string
Returns
Type Description
string query
methodpublicgetQueryString( ) : string
Returns
Type Description
string querystring
methodpublicgetQueryUrl( ) : string

Gets the full query URL for this query.

Returns
Type Description
string url
methodpublicgetStartIndex( ) : int
Returns
Type Description
int startIndex
methodpublicgetTitle( ) : string

Gets the title attribute for this query.

Returns
Type Description
string title
methodpublicgetTitleExact( ) : string

Gets the title-exact attribute for this query.

Returns
Type Description
string title-exact
methodpublicgetUpdatedMax( ) : string
Returns
Type Description
string updatedMax
methodpublicgetUpdatedMin( ) : string
Returns
Type Description
string updatedMin
methodpublicgetVisibility( ) : string

Gets the visibility for this query.

Returns
Type Description
string visibility
methodpublicresetParameters( ) : void
methodpublicsetAlt( string $value ) : \Zend_Gdata_Query

Inherited from: \Zend_Gdata_Query::setAlt()
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetAuthor( string $value ) : \Zend_Gdata_Query
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetCategory( string $value ) : \Zend_Gdata_Query
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetMaxResults( int $value ) : \Zend_Gdata_Query
Parameters
Name Type Description
$value int
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetParam( string $name, string $value ) : \Zend_Gdata_Query
Parameters
Name Type Description
$name string
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetProjection( 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
methodpublicsetPublishedMax( string $value ) : \Zend_Gdata_Query
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetPublishedMin( string $value ) : \Zend_Gdata_Query
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetQuery( string $value ) : \Zend_Gdata_Query
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetStartIndex( int $value ) : \Zend_Gdata_Query
Parameters
Name Type Description
$value int
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetTitle( 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
methodpublicsetTitleExact( 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
methodpublicsetUpdatedMax( string $value ) : \Zend_Gdata_Query
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetUpdatedMin( string $value ) : \Zend_Gdata_Query
Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_Query Provides a fluent interface
methodpublicsetVisibility(  $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
Documentation was generated by DocBlox 0.13.3.