## Zend_Gdata_Health_Query

Description

Assists in constructing queries for Google Health

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

Located in /Gdata/Health/Query.php (line 40)

    Zend_Gdata_Query
       |
       --Zend_Gdata_Health_Query

Class Constant Summary
HEALTH_PROFILE_FEED_URI = 'https://www.google.com/health/feeds/profile/default'
HEALTH_REGISTER_FEED_URI = 'https://www.google.com/health/feeds/register/default'
ITEM_CATEGORY_NS = 'http://schemas.google.com/health/item'
Variable Summary
string $_defaultFeedUri
Method Summary
string getCategory ()
string getDigest ()
string getGrouped ()
int getMaxResultsGroup ()
int getMaxResultsInGroup ()
int getStartIndexGroup ()
int getStartIndexInGroup ()
Zend_Gdata_Health_Query setCategory (string $item, [string $name = null])
Zend_Gdata_Health_Query setDigest (string $value)
Zend_Gdata_Health_Query setGrouped (string $value)
Zend_Gdata_Health_Query setMaxResultsGroup (int $value)
Zend_Gdata_Health_Query setMaxResultsInGroup (int $value)
Zend_Gdata_Health_Query setStartIndexGroup (int $value)
Zend_Gdata_Health_Query setStartIndexInGroup (int $value)
Variables
string $_defaultFeedUri = self::HEALTH_PROFILE_FEED_URI (line 64)

The default URI for POST methods

- access: protected

Redefinition of:

Zend_Gdata_Query::$_defaultFeedUri
  Default URL

#### Inherited Variables

Inherited from Zend_Gdata_Query

> Zend_Gdata_Query::$_category
> Zend_Gdata_Query::$_params
> Zend_Gdata_Query::$_url

Methods
getCategory (line 114)

Returns the query object's category.

- return: id
- access: public

string getCategory ()

Redefinition of:

Zend_Gdata_Query::getCategory()

getDigest (line 85)

Returns the digest parameter's value.

- return: The value set for the digest parameter.
- access: public

string getDigest ()
getGrouped (line 138)

Returns the value set for the grouped parameter.

- return: grouped parameter.
- access: public

string getGrouped ()
getMaxResultsGroup (line 175)

Returns the value set for max-results-group.

- return: Returns max-results-group parameter.
- access: public

int getMaxResultsGroup ()
getMaxResultsInGroup (line 212)

Returns the value set for max-results-in-group.

- return: Returns max-results-in-group parameter.
- access: public

int getMaxResultsInGroup ()
getStartIndexGroup (line 246)

Returns the value set for start-index-group.

- return: Returns start-index-group parameter.
- access: public

int getStartIndexGroup ()
getStartIndexInGroup (line 277)

Returns the value set for start-index-in-group.

- return: Returns start-index-in-group parameter.
- access: public

int getStartIndexInGroup ()
setCategory (line 102)

Setter for category queries.

- return: Provides a fluent interface
- access: public

Zend_Gdata_Health_Query setCategory (string $item, [string $name = null])

- string $item: A category to query.
- string $name: (optional) A specific item to search a category for. An example would be 'Lipitor' if $item is set to 'medication'.

Redefinition of:

Zend_Gdata_Query::setCategory()

setDigest (line 72)

Sets the digest parameter's value.

- return: Provides a fluent interface
- access: public

Zend_Gdata_Health_Query setDigest (string $value)

- string $value

setGrouped (line 125)

Setter for the grouped parameter.

- return: Provides a fluent interface
- access: public

Zend_Gdata_Health_Query setGrouped (string $value)

- string $value: setting a count of results per group.

setMaxResultsGroup (line 155)

Setter for the max-results-group parameter.

- return: Provides a fluent interface
- access: public

Zend_Gdata_Health_Query setMaxResultsGroup (int $value)

- int $value: Specifies the maximum number of groups to be retrieved. Must be an integer value greater than zero. This parameter is only valid if grouped=true.

setMaxResultsInGroup (line 193)

Setter for the max-results-group parameter.

- return: Provides a fluent interface
- access: public

Zend_Gdata_Health_Query setMaxResultsInGroup (int $value)

- int $value: Specifies the maximum number of records to be retrieved from each group. The limits that you specify with this parameter apply to all groups. Must be an integer value greater than zero. This parameter is only valid if grouped=true.

setStartIndexGroup (line 230)

Setter for the start-index-group parameter.

- return: Provides a fluent interface
- access: public

Zend_Gdata_Health_Query setStartIndexGroup (int $value)

- int $value: Retrieves only items whose group ranking is at least start-index-group. This should be set to a 1-based index of the first group to be retrieved. The range is applied per category. This parameter is only valid if grouped=true.

setStartIndexInGroup (line 262)

Setter for the start-index-in-group parameter.

- return: Provides a fluent interface
- access: public

Zend_Gdata_Health_Query setStartIndexInGroup (int $value)

- int $value: A 1-based index of the records to be retrieved from each group. This parameter is only valid if grouped=true.

#### Inherited Methods

Inherited From Zend_Gdata_Query

> Zend_Gdata_Query::__construct()
> Zend_Gdata_Query::getAlt()
> Zend_Gdata_Query::getAuthor()
> Zend_Gdata_Query::getCategory()
> Zend_Gdata_Query::getMaxResults()
> Zend_Gdata_Query::getParam()
> Zend_Gdata_Query::getPublishedMax()
> Zend_Gdata_Query::getPublishedMin()
> Zend_Gdata_Query::getQuery()
> Zend_Gdata_Query::getQueryString()
> Zend_Gdata_Query::getQueryUrl()
> Zend_Gdata_Query::getStartIndex()
> Zend_Gdata_Query::getUpdatedMax()
> Zend_Gdata_Query::getUpdatedMin()
> Zend_Gdata_Query::resetParameters()
> Zend_Gdata_Query::setAlt()
> Zend_Gdata_Query::setAuthor()
> Zend_Gdata_Query::setCategory()
> Zend_Gdata_Query::setMaxResults()
> Zend_Gdata_Query::setParam()
> Zend_Gdata_Query::setPublishedMax()
> Zend_Gdata_Query::setPublishedMin()
> Zend_Gdata_Query::setQuery()
> Zend_Gdata_Query::setStartIndex()
> Zend_Gdata_Query::setUpdatedMax()
> Zend_Gdata_Query::setUpdatedMin()
> Zend_Gdata_Query::__get()
> Zend_Gdata_Query::__set()

Class Constants
HEALTH_PROFILE_FEED_URI =
'https://www.google.com/health/feeds/profile/default' (line 45)

URI of a user's profile feed.

HEALTH_REGISTER_FEED_URI =
'https://www.google.com/health/feeds/register/default' (line 51)

URI of register (notices) feed.

ITEM_CATEGORY_NS = 'http://schemas.google.com/health/item' (line 57)

Namespace for an item category

Documentation generated on Tue, 26 Oct 2010 20:09:09 +0400 by phpDocumentor 1.4.2