API Documentation

Zend/Gdata/Docs/Query.php

Show: inherited
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
Docs  
Version
$Id: Query.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Gdata_Docs_Query

Package: Zend\Gdata\Docs

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

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

The base URL for retrieving a document list

string

Properties

Propertyprotectedstring  $_defaultFeedUri= 'self::DOCUMENTS_LIST_FEED_URI'

The generic base URL used by some inherited methods

Default valueself::DOCUMENTS_LIST_FEED_URIDetails
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 value'full'Details
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 value'private'Details
Type
string

Methods

methodpublic__construct( ) : void

Constructs a new instance of a Zend_Gdata_Docs_Query object.

methodpublicgetProjection( ) : string

Gets the projection for this query.

Returns
Type Description
string projection
methodpublicgetQueryUrl( ) : string

Gets the full query URL for this query.

Returns
Type Description
string url
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
methodpublicgetVisibility( ) : string

Gets the visibility for this query.

Returns
Type Description
string visibility
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
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
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.15.1.