## API Documentation

# Gdata/Health/Query.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)
license
  New BSD License
package
  Zend_Gdata
subpackage
  Health
version
  $Id: Query.php 23775 2011-03-01 17:25:24Z ralph $

## \Zend_Gdata_Health_Query
jump to top

Assists in constructing queries for Google Health

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

Extends from
  \Zend_Gdata_Query
category
  Zend
copyright
  Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
license
  New BSD License
link
  http://code.google.com/apis/health
package
  Zend_Gdata
subpackage
  Health

### Constants

`HEALTH_PROFILE_FEED_URI = 'https://www.google.com/health/feeds/profile/default'`

URI of a user's profile feed.

`HEALTH_REGISTER_FEED_URI = 'https://www.google.com/health/feeds/register/default'`

URI of register (notices) feed.

`ITEM_CATEGORY_NS = 'http://schemas.google.com/health/item'`

Namespace for an item category

### Properties

`string $_defaultFeedUri= 'self'`

The default URI for POST methods

Default value `self` Details

Type
  string

### Methods

`__construct( $url = null ) : void`

Create Gdata_Query object

Inherited from: \Zend_Gdata_Query::__construct()
Parameters

Name | Type | Description
--- | --- | ---
$url |  |

`__get( $name ) : void`

Inherited from: \Zend_Gdata_Query::__get()
Parameters

Name | Type | Description
--- | --- | ---
$name |  |

`__set( $name, $val ) : void`

Inherited from: \Zend_Gdata_Query::__set()
Parameters

Name | Type | Description
--- | --- | ---
$name |  |
$val |  |

`getAlt( ) : string`

Inherited from: \Zend_Gdata_Query::getAlt()
Returns

Type | Description
--- | ---
string | rss or atom

`getAuthor( ) : string`

Inherited from: \Zend_Gdata_Query::getAuthor()
Returns

Type | Description
--- | ---
string | author

`getCategory( ) : string`

Returns the query object's category.

Returns

Type | Description
--- | ---
string | id

`getDigest( ) : string`

Returns the digest parameter's value.

Returns

Type | Description
--- | ---
string | The value set for the digest parameter.

`getGrouped( ) : string`

Returns the value set for the grouped parameter.

Returns

Type | Description
--- | ---
string | grouped parameter.

`getMaxResults( ) : int`

Inherited from: \Zend_Gdata_Query::getMaxResults()
Returns

Type | Description
--- | ---
int | maxResults

`getMaxResultsGroup( ) : int`

Returns the value set for max-results-group.

Returns

Type | Description
--- | ---
int | Returns max-results-group parameter.

`getMaxResultsInGroup( ) : int`

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

Returns

Type | Description
--- | ---
int | Returns max-results-in-group parameter.

`getParam( string $name ) : void`

Inherited from: \Zend_Gdata_Query::getParam()
Parameters

Name | Type | Description
--- | --- | ---
$name | string |

`getPublishedMax( ) : string`

Inherited from: \Zend_Gdata_Query::getPublishedMax()
Returns

Type | Description
--- | ---
string | publishedMax

`getPublishedMin( ) : string`

Inherited from: \Zend_Gdata_Query::getPublishedMin()
Returns

Type | Description
--- | ---
string | publishedMin

`getQuery( ) : string`

Inherited from: \Zend_Gdata_Query::getQuery()
Returns

Type | Description
--- | ---
string | query

`getQueryString( ) : string`

Inherited from: \Zend_Gdata_Query::getQueryString()
Returns

Type | Description
--- | ---
string | querystring

`getQueryUrl( ) : string`

Inherited from: \Zend_Gdata_Query::getQueryUrl()
Returns

Type | Description
--- | ---
string | url

`getStartIndex( ) : int`

Inherited from: \Zend_Gdata_Query::getStartIndex()
Returns

Type | Description
--- | ---
int | startIndex

`getStartIndexGroup( ) : int`

Returns the value set for start-index-group.

Returns

Type | Description
--- | ---
int | Returns start-index-group parameter.

`getStartIndexInGroup( ) : int`

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

Returns

Type | Description
--- | ---
int | Returns start-index-in-group parameter.

`getUpdatedMax( ) : string`

Inherited from: \Zend_Gdata_Query::getUpdatedMax()
Returns

Type | Description
--- | ---
string | updatedMax

`getUpdatedMin( ) : string`

Inherited from: \Zend_Gdata_Query::getUpdatedMin()
Returns

Type | Description
--- | ---
string | updatedMin

`resetParameters( ) : void`

Inherited from: \Zend_Gdata_Query::resetParameters()
`setAlt( string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setAlt()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setAuthor( string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setAuthor()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setCategory( string $item, string $name = null ) : \Zend_Gdata_Health_Query`

Setter for category queries.

Parameters

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

Returns

Type | Description
--- | ---
\Zend_Gdata_Health_Query | Provides a fluent interface

`setDigest( string $value ) : \Zend_Gdata_Health_Query`

Sets the digest parameter's value.

Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Health_Query | Provides a fluent interface

`setGrouped( string $value ) : \Zend_Gdata_Health_Query`

Setter for the grouped parameter.

Parameters

Name | Type | Description
--- | --- | ---
$value | string | setting a count of results per group.

Returns

Type | Description
--- | ---
\Zend_Gdata_Health_Query | Provides a fluent interface

`setMaxResults( int $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setMaxResults()
Parameters

Name | Type | Description
--- | --- | ---
$value | int |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setMaxResultsGroup( int $value ) : \Zend_Gdata_Health_Query`

Setter for the max-results-group parameter.

Parameters

Name | Type | Description
--- | --- | ---
$value | int | 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.

Returns

Type | Description
--- | ---
\Zend_Gdata_Health_Query | Provides a fluent interface

`setMaxResultsInGroup( int $value ) : \Zend_Gdata_Health_Query`

Setter for the max-results-group parameter.

Parameters

Name | Type | Description
--- | --- | ---
$value | int | 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.

Returns

Type | Description
--- | ---
\Zend_Gdata_Health_Query | Provides a fluent interface

`setParam( string $name, string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setParam()
Parameters

Name | Type | Description
--- | --- | ---
$name | string |
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setPublishedMax( string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setPublishedMax()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setPublishedMin( string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setPublishedMin()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setQuery( string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setQuery()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setStartIndex( int $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setStartIndex()
Parameters

Name | Type | Description
--- | --- | ---
$value | int |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setStartIndexGroup( int $value ) : \Zend_Gdata_Health_Query`

Setter for the start-index-group parameter.

Parameters

Name | Type | Description
--- | --- | ---
$value | int | 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.

Returns

Type | Description
--- | ---
\Zend_Gdata_Health_Query | Provides a fluent interface

`setStartIndexInGroup( int $value ) : \Zend_Gdata_Health_Query`

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

Parameters

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

Returns

Type | Description
--- | ---
\Zend_Gdata_Health_Query | Provides a fluent interface

`setUpdatedMax( string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setUpdatedMax()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

`setUpdatedMin( string $value ) : \Zend_Gdata_Query`

Inherited from: \Zend_Gdata_Query::setUpdatedMin()
Parameters

Name | Type | Description
--- | --- | ---
$value | string |

Returns

Type | Description
--- | ---
\Zend_Gdata_Query | Provides a fluent interface

Documentation was generated by DocBlox 0.13.3.