API Documentation

Zend/Gdata/Health/Query.php

Show: inherited
Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Gdata  
Subpackage
Health  
Version
$Id: Query.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Gdata_Health_Query

Package: Zend\Gdata\Health

Assists in constructing queries for Google Health

Parent(s)
\Zend_Gdata_Query
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Link
http://code.google.com/apis/health  

Constants

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

URI of a user's profile feed.

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

URI of register (notices) feed.

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

Namespace for an item category

Properties

Propertyprotectedstring  $_defaultFeedUri= 'self::HEALTH_PROFILE_FEED_URI'

The default URI for POST methods

Default valueself::HEALTH_PROFILE_FEED_URIDetails
Type
string

Methods

methodpublicgetCategory( ) : string

Returns the query object's category.

Returns
Type Description
string id
methodpublicgetDigest( ) : string

Returns the digest parameter's value.

Returns
Type Description
string The value set for the digest parameter.
methodpublicgetGrouped( ) : string

Returns the value set for the grouped parameter.

Returns
Type Description
string grouped parameter.
methodpublicgetMaxResultsGroup( ) : int

Returns the value set for max-results-group.

Returns
Type Description
int Returns max-results-group parameter.
methodpublicgetMaxResultsInGroup( ) : int

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

Returns
Type Description
int Returns max-results-in-group parameter.
methodpublicgetStartIndexGroup( ) : int

Returns the value set for start-index-group.

Returns
Type Description
int Returns start-index-group parameter.
methodpublicgetStartIndexInGroup( ) : int

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

Returns
Type Description
int Returns start-index-in-group parameter.
methodpublicsetCategory( 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
methodpublicsetDigest( 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
methodpublicsetGrouped( 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
methodpublicsetMaxResultsGroup( 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
methodpublicsetMaxResultsInGroup( 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
methodpublicsetStartIndexGroup( 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
methodpublicsetStartIndexInGroup( 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
Documentation was generated by DocBlox 0.15.1.