Docs For Class Zend_Gdata

Zend_Gdata_Query

Description

Provides a mechanism to build a query URL for Gdata services.

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

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Direct descendents

Class	Description
Zend_Gdata_Health_Query	Assists in constructing queries for Google Health
Zend_Gdata_Spreadsheets_CellQuery	Assists in constructing queries for Google Spreadsheets cells
Zend_Gdata_Spreadsheets_DocumentQuery	Assists in constructing queries for Google Spreadsheets documents
Zend_Gdata_Spreadsheets_ListQuery	Assists in constructing queries for Google Spreadsheets lists
Zend_Gdata_Gapps_Query	Assists in constructing queries for Google Apps entries. This class provides common methods used by all other Google Apps query classes.
Zend_Gdata_Docs_Query	Assists in constructing queries for Google Document List documents
Zend_Gdata_Gbase_Query	Assists in constructing queries for Google Base
Zend_Gdata_Photos_UserQuery	Assists in constructing queries for user entries.
Zend_Gdata_Books_VolumeQuery	Assists in constructing queries for Books volumes
Zend_Gdata_Calendar_EventQuery	Assists in constructing queries for Google Calendar events
Zend_Gdata_YouTube_VideoQuery	Assists in constructing queries for YouTube videos

Variable Summary

string $_category

string $_defaultFeedUri

array $_params

string $_url

Method Summary

Zend_Gdata_Query __construct ([ $url = null])

string getAlt ()

string getAuthor ()

void getCategory ()

int getMaxResults ()

void getParam (string $name)

string getPublishedMax ()

string getPublishedMin ()

string getQuery ()

string getQueryString ()

string getQueryUrl ()

int getStartIndex ()

string getUpdatedMax ()

string getUpdatedMin ()

void resetParameters ()

Zend_Gdata_Query setAlt (string $value)

Zend_Gdata_Query setAuthor (string $value)

Zend_Gdata_Query setCategory (string $value)

Zend_Gdata_Query setMaxResults (int $value)

Zend_Gdata_Query setParam (string $name, string $value)

Zend_Gdata_Query setPublishedMax (string $value)

Zend_Gdata_Query setPublishedMin (string $value)

Zend_Gdata_Query setQuery (string $value)

Zend_Gdata_Query setStartIndex (int $value)

Zend_Gdata_Query setUpdatedMax (string $value)

Zend_Gdata_Query setUpdatedMin (string $value)

void __get ( $name)

void __set ( $name, $val)

Variables

string $_category = null (line 70)

Category for the query

access: protected

string $_defaultFeedUri = null (line 55)

Default URL

access: protected

Redefined in descendants as:

Zend_Gdata_Health_Query::$_defaultFeedUri : The default URI for POST methods
Zend_Gdata_Spreadsheets_CellQuery::$_defaultFeedUri
Zend_Gdata_Spreadsheets_DocumentQuery::$_defaultFeedUri
Zend_Gdata_Spreadsheets_ListQuery::$_defaultFeedUri
Zend_Gdata_Docs_Query::$_defaultFeedUri : The generic base URL used by some inherited methods
Zend_Gdata_Gbase_Query::$_defaultFeedUri : The default URI for POST methods
Zend_Gdata_Gbase_SnippetQuery::$_defaultFeedUri : The default URI for POST methods
Zend_Gdata_Gbase_ItemQuery::$_defaultFeedUri : The default URI for POST methods
Zend_Gdata_Calendar_EventQuery::$_defaultFeedUri : The default URI used for feeds.

array $_params = array() (line 48)

Query parameters.

access: protected

string $_url = null (line 63)

Base URL TODO: Add setters and getters

access: protected

Methods

Constructor __construct (line 75)

Create Gdata_Query object

access: public

Zend_Gdata_Query __construct ([ $url = null])

$url

Redefined in descendants as:

Zend_Gdata_Spreadsheets_CellQuery::__construct() : Constructs a new Zend_Gdata_Spreadsheets_CellQuery object.
Zend_Gdata_Spreadsheets_DocumentQuery::__construct() : Constructs a new Zend_Gdata_Spreadsheets_DocumentQuery object.
Zend_Gdata_Spreadsheets_ListQuery::__construct() : Constructs a new Zend_Gdata_Spreadsheets_ListQuery object.
Zend_Gdata_Gapps_Query::__construct() : Create a new instance.
Zend_Gdata_Gapps_EmailListRecipientQuery::__construct() : Create a new instance.
Zend_Gdata_Gapps_EmailListQuery::__construct() : Create a new instance.
Zend_Gdata_Gapps_UserQuery::__construct() : Create a new instance.
Zend_Gdata_Gapps_NicknameQuery::__construct() : Create a new instance.
Zend_Gdata_Docs_Query::__construct() : Constructs a new instance of a Zend_Gdata_Docs_Query object.
Zend_Gdata_Photos_UserQuery::__construct() : Create a new Query object with default values.
Zend_Gdata_Books_VolumeQuery::__construct() : Create Gdata_Books_VolumeQuery object
Zend_Gdata_Calendar_EventQuery::__construct() : Create Gdata_Calendar_EventQuery object. If a URL is provided,
Zend_Gdata_YouTube_VideoQuery::__construct() : Create Gdata_YouTube_VideoQuery object

getAlt (line 272)

return: rss or atom
access: public

string getAlt ()

getAuthor (line 368)

return: author
access: public

string getAuthor ()

getCategory (line 390)

access: public

void getCategory ()

Redefined in descendants as:

Zend_Gdata_Health_Query::getCategory() : Returns the query object's category.

getMaxResults (line 284)

return: maxResults
access: public

int getMaxResults ()

getParam (line 138)

access: public

void getParam (string $name)

string $name

getPublishedMax (line 344)

return: publishedMax
access: public

string getPublishedMax ()

getPublishedMin (line 356)

return: publishedMin
access: public

string getPublishedMin ()

getQuery (line 296)

return: query
access: public

string getQuery ()

getQueryString (line 83)

return: querystring
access: public

string getQueryString ()

Redefined in descendants as:

Zend_Gdata_Spreadsheets_CellQuery::getQueryString() : Gets the attribute query string for this query.
Zend_Gdata_Spreadsheets_DocumentQuery::getQueryString() : Gets the attribute query string for this query.
Zend_Gdata_Spreadsheets_ListQuery::getQueryString() : Gets the attribute query string for this query.
Zend_Gdata_YouTube_VideoQuery::getQueryString() : Generate the query string from the URL parameters, optionally modifying them based on protocol version.

getQueryUrl (line 110)

return: url
access: public

string getQueryUrl ()

Redefined in descendants as:

Zend_Gdata_Spreadsheets_CellQuery::getQueryUrl() : Gets the full query URL for this query.
Zend_Gdata_Spreadsheets_DocumentQuery::getQueryUrl() : Gets the full query URL for this query.
Zend_Gdata_Spreadsheets_ListQuery::getQueryUrl() : Gets the full query URL for this query.
Zend_Gdata_Gapps_EmailListRecipientQuery::getQueryUrl() : Returns the URL generated for this query, based on it's current parameters.
Zend_Gdata_Gapps_EmailListQuery::getQueryUrl() : Returns the URL generated for this query, based on it's current parameters.
Zend_Gdata_Gapps_UserQuery::getQueryUrl() : Returns the query URL generated by this query instance.
Zend_Gdata_Gapps_NicknameQuery::getQueryUrl() : Returns the URL generated for this query, based on it's current parameters.
Zend_Gdata_Docs_Query::getQueryUrl() : Gets the full query URL for this query.
Zend_Gdata_Gbase_SnippetQuery::getQueryUrl() : Returns the query URL generated by this query instance.
Zend_Gdata_Gbase_ItemQuery::getQueryUrl() : Returns the query URL generated by this query instance.
Zend_Gdata_Photos_UserQuery::getQueryUrl() : Returns the URL generated for this query, based on it's current parameters.
Zend_Gdata_Photos_AlbumQuery::getQueryUrl() : Returns the URL generated for this query, based on it's current parameters.
Zend_Gdata_Photos_PhotoQuery::getQueryUrl() : Returns the URL generated for this query, based on it's current parameters.
Zend_Gdata_Books_VolumeQuery::getQueryUrl() : Returns the generated full query URL
Zend_Gdata_Calendar_EventQuery::getQueryUrl()
Zend_Gdata_YouTube_VideoQuery::getQueryUrl() : Returns the generated full query URL, optionally modifying it based on the protocol version.

getStartIndex (line 308)

return: startIndex
access: public

int getStartIndex ()

getUpdatedMax (line 320)

return: updatedMax
access: public

string getUpdatedMax ()

getUpdatedMin (line 332)

return: updatedMin
access: public

string getUpdatedMin ()

resetParameters (line 102)

access: public

void resetParameters ()

setAlt (line 147)

return: Provides a fluent interface
access: public

Zend_Gdata_Query setAlt (string $value)

string $value

setAuthor (line 259)

return: Provides a fluent interface
access: public

Zend_Gdata_Query setAuthor (string $value)

string $value

setCategory (line 381)

return: Provides a fluent interface
access: public

Zend_Gdata_Query setCategory (string $value)

string $value

Redefined in descendants as:

Zend_Gdata_Health_Query::setCategory() : Setter for category queries.

setMaxResults (line 161)

return: Provides a fluent interface
access: public

Zend_Gdata_Query setMaxResults (int $value)

int $value

setParam (line 129)

return: Provides a fluent interface
access: public

Zend_Gdata_Query setParam (string $name, string $value)

string $name
string $value

setPublishedMax (line 231)

return: Provides a fluent interface
access: public

Zend_Gdata_Query setPublishedMax (string $value)

string $value

setPublishedMin (line 245)

return: Provides a fluent interface
access: public

Zend_Gdata_Query setPublishedMin (string $value)

string $value

setQuery (line 175)

return: Provides a fluent interface
access: public

Zend_Gdata_Query setQuery (string $value)

string $value

setStartIndex (line 189)

return: Provides a fluent interface
access: public

Zend_Gdata_Query setStartIndex (int $value)

int $value

setUpdatedMax (line 203)

return: Provides a fluent interface
access: public

Zend_Gdata_Query setUpdatedMax (string $value)

string $value

setUpdatedMin (line 217)

return: Provides a fluent interface
access: public

Zend_Gdata_Query setUpdatedMin (string $value)

string $value

__get (line 396)

access: public

void __get ( $name)

$name

__set (line 407)

access: public

void __set ( $name, $val)

$name
$val

Documentation generated on Mon, 21 Jun 2010 15:40:35 -0400 by phpDocumentor 1.4.3