API Documentation

Gdata/Docs/Query.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
Docs
version
$Id: Query.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Gdata_Docs_Query

Description

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.

Zend_Gdata_Docs_Query
jump to top

Extends from
Zend_Gdata_Query
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
link
http://code.google.com/apis/gdata/spreadsheets/
package
Zend_Gdata
subpackage
Docs
Constants
DOCUMENTS_LIST_FEED_URI
Properties
$_defaultFeedUri
$_visibility
$_projection
Methods
__construct
setProjection
setVisibility
getProjection
getVisibility
setTitle
getTitle
setTitleExact
getTitleExact
getQueryUrl

Description

Assists in constructing queries for Google Document List documents

Constants

DOCUMENTS_LIST_FEED_URI
jump to class

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

The base URL for retrieving a document list

Details

value
http://docs.google.com/feeds/documents
DOCUMENTS_LIST_FEED_URI
string

Properties

$_defaultFeedUri
jump to class

string $_defaultFeedUri = 'self'

The generic base URL used by some inherited methods

Details

$_defaultFeedUri
string
visibility
protected
default
self
final
false
static
false

$_projection
jump to class

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.

Details

$_projection
string
visibility
protected
default
full
final
false
static
false

$_visibility
jump to class

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.

Details

$_visibility
string
visibility
protected
default
private
final
false
static
false

Methods

__construct
jump to class

__construct( ) :

Constructs a new instance of a Zend_Gdata_Docs_Query object.

Details
visibility
public
final
false
static
false

getProjection
jump to class

getProjection( ) : string

Gets the projection for this query.

Output
string
projection
Details
visibility
public
final
false
static
false

getQueryUrl
jump to class

getQueryUrl( ) : string

Gets the full query URL for this query.

Output
string
url
Details
visibility
public
final
false
static
false

getTitle
jump to class

getTitle( ) : string

Gets the title attribute for this query.

Output
string
title
Details
visibility
public
final
false
static
false

getTitleExact
jump to class

getTitleExact( ) : string

Gets the title-exact attribute for this query.

Output
string
title-exact
Details
visibility
public
final
false
static
false

getVisibility
jump to class

getVisibility( ) : string

Gets the visibility for this query.

Output
string
visibility
Details
visibility
public
final
false
static
false

setProjection
jump to class

setProjection( string $value ) : Zend_Gdata_Docs_Query

Sets the projection for this query. Common values for projection include 'full'.

Arguments
$value
string
Output
Zend_Gdata_Docs_Query
Provides a fluent interface
Details
visibility
public
final
false
static
false

setTitle
jump to class

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.

Arguments
$value
string
Output
Zend_Gdata_Docs_Query
Provides a fluent interface
Details
visibility
public
final
false
static
false

setTitleExact
jump to class

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.

Arguments
$value
boolean
Use either true or false
Output
Zend_Gdata_Docs_Query
Provides a fluent interface
Details
visibility
public
final
false
static
false

setVisibility
jump to class

setVisibility(  $value ) : Zend_Gdata_Docs_Query

Sets the visibility for this query. Common values for visibility include 'private'.

Arguments
$value
Output
Zend_Gdata_Docs_Query
Provides a fluent interface
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.