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
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
Properties



string $_defaultFeedUri=
'self'
The default URI for POST methods
Default valueself
Details
- Type
- string
Methods



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. |



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. |



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. |



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



setDigest( string $value ) : \Zend_Gdata_Health_Query
Sets the digest parameter's value.
Parameters
Name |
Type |
Description |
$value |
string |
|
Returns



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



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



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



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



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