Gdata/Spreadsheets/DocumentQuery.php

category: Zend
copyright: Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Gdata
subpackage: Spreadsheets
version: $Id: DocumentQuery.php 23805 2011-03-16 00:55:40Z tjohns $
Classes: Zend_Gdata_Spreadsheets_DocumentQuery

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_Spreadsheets_DocumentQuery
jump to top

Extends from: Zend_Gdata_Query
category: Zend
copyright: Copyright (c) 2005-2011 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: Spreadsheets
Constants: SPREADSHEETS_FEED_URI
Properties: $_defaultFeedUri; $_documentType; $_visibility; $_projection; $_spreadsheetKey; $_worksheetId
Methods: __construct; setSpreadsheetKey; getSpreadsheetKey; setWorksheetId; getWorksheetId; setDocumentType; getDocumentType; setProjection; setVisibility; getProjection; getVisibility; setTitle; setTitleExact; getTitle; getTitleExact; appendVisibilityProjection; getQueryUrl; getQueryString

Description

Assists in constructing queries for Google Spreadsheets documents

Constants

SPREADSHEETS_FEED_URI
jump to class

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

Details

value: https://spreadsheets.google.com/feeds

Properties

$_defaultFeedUri
jump to class

$_defaultFeedUri = 'self'

Details

visibility: protected
default: self
final: false
static: false

$_documentType
jump to class

$_documentType = ''

Details

visibility: protected
default
final: false
static: false

$_projection
jump to class

$_projection = 'full'

Details

visibility: protected
default: full
final: false
static: false

$_spreadsheetKey
jump to class

$_spreadsheetKey = 'null'

Details

visibility: protected
default: null
final: false
static: false

$_visibility
jump to class

$_visibility = 'private'

Details

visibility: protected
default: private
final: false
static: false

$_worksheetId
jump to class

$_worksheetId = 'null'

Details

visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

__construct(
          
          )
        
        :

Constructs a new Zend_Gdata_Spreadsheets_DocumentQuery object.

Details

visibility: public
final: false
static: false

appendVisibilityProjection
jump to class

appendVisibilityProjection(
          
          )
        
        :

Details

visibility: private
final: false
static: false

getDocumentType
jump to class

getDocumentType(
          
          )
        
        :
        string

Gets the document type for this query.

Output

string: document type

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

getQueryString
jump to class

getQueryString(
          
          )
        
        :
        string

Gets the attribute query string for this query.

Output

string: query string

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

getSpreadsheetKey
jump to class

getSpreadsheetKey(
          
          )
        
        :
        string

Gets the spreadsheet key for this query.

Output

string: spreadsheet key

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

getWorksheetId
jump to class

getWorksheetId(
          
          )
        
        :
        string

Gets the worksheet id for this query.

Output

string: worksheet id

Details

visibility: public
final: false
static: false

setDocumentType
jump to class

setDocumentType(
          string $value
          )
        
        :
        Zend_Gdata_Spreadsheets_DocumentQuery

Sets the document type for this query.

Arguments

$value: string
spreadsheets or worksheets

Output

Zend_Gdata_Spreadsheets_DocumentQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false

setProjection
jump to class

setProjection(
          string $value
          )
        
        :
        Zend_Gdata_Spreadsheets_DocumentQuery

Sets the projection for this query.

Arguments

$value: string

Output

Zend_Gdata_Spreadsheets_DocumentQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false

setSpreadsheetKey
jump to class

setSpreadsheetKey(
          string $value
          )
        
        :
        Zend_Gdata_Spreadsheets_CellQuery

Sets the spreadsheet key for this query.

Arguments

$value: string

Output

Zend_Gdata_Spreadsheets_CellQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false

setTitle
jump to class

setTitle(
          string $value
          )
        
        :
        Zend_Gdata_Spreadsheets_DocumentQuery

Sets the title attribute for this query.

Arguments

$value: string

Output

Zend_Gdata_Spreadsheets_DocumentQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false

setTitleExact
jump to class

setTitleExact(
          string $value
          )
        
        :
        Zend_Gdata_Spreadsheets_DocumentQuery

Sets the title-exact attribute for this query.

Arguments

$value: string

Output

Zend_Gdata_Spreadsheets_DocumentQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false

setVisibility
jump to class

setVisibility(
           $value
          )
        
        :
        Zend_Gdata_Spreadsheets_DocumentQuery

Sets the visibility for this query.

Arguments

$value

Output

Zend_Gdata_Spreadsheets_DocumentQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false

setWorksheetId
jump to class

setWorksheetId(
          string $value
          )
        
        :
        Zend_Gdata_Spreadsheets_CellQuery

Sets the worksheet id for this query.

Arguments

$value: string

Output

Zend_Gdata_Spreadsheets_CellQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false

API Documentation

Gdata/Spreadsheets/DocumentQuery.php

Description

Zend_Gdata_Spreadsheets_DocumentQueryjump to top

Description

Constants

SPREADSHEETS_FEED_URIjump to class

Details

Properties

$_defaultFeedUrijump to class

Details

$_documentTypejump to class

Details

$_projectionjump to class

Details

$_spreadsheetKeyjump to class

Details

$_visibilityjump to class

Details

$_worksheetIdjump to class

Details

Methods

__constructjump to class

Details

appendVisibilityProjectionjump to class

Details

getDocumentTypejump to class

Output

Details

getProjectionjump to class

Output

Details

getQueryStringjump to class

Output

Details

getQueryUrljump to class

Output

Details

getSpreadsheetKeyjump to class

Output

Details

getTitlejump to class

Output

Details

getTitleExactjump to class

Output

Details

getVisibilityjump to class

Output

Details

getWorksheetIdjump to class

Output

Details

setDocumentTypejump to class

Arguments

Output

Details

setProjectionjump to class

Arguments

Output

Details

setSpreadsheetKeyjump to class

Arguments

Output

Details

setTitlejump to class

Arguments

Output

Details

setTitleExactjump to class

Arguments

Output

Details

setVisibilityjump to class

Arguments

Output

Details

setWorksheetIdjump to class

Arguments

Output

Zend_Gdata_Spreadsheets_DocumentQuery
jump to top

SPREADSHEETS_FEED_URI
jump to class

$_defaultFeedUri
jump to class

$_documentType
jump to class

$_projection
jump to class

$_spreadsheetKey
jump to class

$_visibility
jump to class

$_worksheetId
jump to class

__construct
jump to class

appendVisibilityProjection
jump to class

getDocumentType
jump to class

getProjection
jump to class

getQueryString
jump to class

getQueryUrl
jump to class

getSpreadsheetKey
jump to class

getTitle
jump to class

getTitleExact
jump to class

getVisibility
jump to class

getWorksheetId
jump to class

setDocumentType
jump to class

setProjection
jump to class

setSpreadsheetKey
jump to class

setTitle
jump to class

setTitleExact
jump to class

setVisibility
jump to class

setWorksheetId
jump to class