Gdata/Health/Query.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Gdata
subpackage: Health
version: $Id: Query.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Gdata_Health_Query

Description

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.

Zend_Gdata_Health_Query
jump to top

Extends from: Zend_Gdata_Query
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
link: http://code.google.com/apis/health
package: Zend_Gdata
subpackage: Health
Constants: HEALTH_PROFILE_FEED_URI; HEALTH_REGISTER_FEED_URI; ITEM_CATEGORY_NS
Properties: $_defaultFeedUri
Methods: setDigest; getDigest; setCategory; getCategory; setGrouped; getGrouped; setMaxResultsGroup; getMaxResultsGroup; setMaxResultsInGroup; getMaxResultsInGroup; setStartIndexGroup; getStartIndexGroup; setStartIndexInGroup; getStartIndexInGroup

Description

Assists in constructing queries for Google Health

Constants

HEALTH_PROFILE_FEED_URI
jump to class

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

URI of a user's profile feed.

Details

value: https://www.google.com/health/feeds/profile/default

HEALTH_REGISTER_FEED_URI
jump to class

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

URI of register (notices) feed.

Details

value: https://www.google.com/health/feeds/register/default

ITEM_CATEGORY_NS
jump to class

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

Namespace for an item category

Details

value: http://schemas.google.com/health/item

Properties

$_defaultFeedUri
jump to class

string $_defaultFeedUri = 'self'

The default URI for POST methods

Details

$_defaultFeedUri: string
visibility: protected
default: self
final: false
static: false

Methods

getCategory
jump to class

getCategory(
          
          )
        
        :
        string

Returns the query object's category.

Output

string: id

Details

visibility: public
final: false
static: false

getDigest
jump to class

getDigest(
          
          )
        
        :
        string

Returns the digest parameter's value.

Output

string: The value set for the digest parameter.

Details

visibility: public
final: false
static: false

getGrouped
jump to class

getGrouped(
          
          )
        
        :
        string

Returns the value set for the grouped parameter.

Output

string: grouped parameter.

Details

visibility: public
final: false
static: false

getMaxResultsGroup
jump to class

getMaxResultsGroup(
          
          )
        
        :
        int

Returns the value set for max-results-group.

Output

int: Returns max-results-group parameter.

Details

visibility: public
final: false
static: false

getMaxResultsInGroup
jump to class

getMaxResultsInGroup(
          
          )
        
        :
        int

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

Output

int: Returns max-results-in-group parameter.

Details

visibility: public
final: false
static: false

getStartIndexGroup
jump to class

getStartIndexGroup(
          
          )
        
        :
        int

Returns the value set for start-index-group.

Output

int: Returns start-index-group parameter.

Details

visibility: public
final: false
static: false

getStartIndexInGroup
jump to class

getStartIndexInGroup(
          
          )
        
        :
        int

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

Output

int: Returns start-index-in-group parameter.

Details

visibility: public
final: false
static: false

setCategory
jump to class

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

Setter for category queries.

Arguments

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

Output

Zend_Gdata_Health_Query: Provides a fluent interface

Details

visibility: public
final: false
static: false

setDigest
jump to class

setDigest(
          string $value
          )
        
        :
        Zend_Gdata_Health_Query

Sets the digest parameter's value.

Arguments

$value: string

Output

Zend_Gdata_Health_Query: Provides a fluent interface

Details

visibility: public
final: false
static: false

setGrouped
jump to class

setGrouped(
          string $value
          )
        
        :
        Zend_Gdata_Health_Query

Setter for the grouped parameter.

Arguments

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

Output

Zend_Gdata_Health_Query: Provides a fluent interface

Details

visibility: public
final: false
static: false

setMaxResultsGroup
jump to class

setMaxResultsGroup(
          int $value
          )
        
        :
        Zend_Gdata_Health_Query

Setter for the max-results-group parameter.

Arguments

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

Output

Zend_Gdata_Health_Query: Provides a fluent interface

Details

visibility: public
final: false
static: false

setMaxResultsInGroup
jump to class

setMaxResultsInGroup(
          int $value
          )
        
        :
        Zend_Gdata_Health_Query

Setter for the max-results-group parameter.

Arguments

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

Output

Zend_Gdata_Health_Query: Provides a fluent interface

Details

visibility: public
final: false
static: false

setStartIndexGroup
jump to class

setStartIndexGroup(
          int $value
          )
        
        :
        Zend_Gdata_Health_Query

Setter for the start-index-group parameter.

Arguments

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

Output

Zend_Gdata_Health_Query: Provides a fluent interface

Details

visibility: public
final: false
static: false

setStartIndexInGroup
jump to class

setStartIndexInGroup(
          int $value
          )
        
        :
        Zend_Gdata_Health_Query

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

Arguments

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

Output

Zend_Gdata_Health_Query: Provides a fluent interface

Details

visibility: public
final: false
static: false

API Documentation

Gdata/Health/Query.php

Description

Zend_Gdata_Health_Queryjump to top

Description

Constants

HEALTH_PROFILE_FEED_URIjump to class

Details

HEALTH_REGISTER_FEED_URIjump to class

Details

ITEM_CATEGORY_NSjump to class

Details

Properties

$_defaultFeedUrijump to class

Details

Methods

getCategoryjump to class

Output

Details

getDigestjump to class

Output

Details

getGroupedjump to class

Output

Details

getMaxResultsGroupjump to class

Output

Details

getMaxResultsInGroupjump to class

Output

Details

getStartIndexGroupjump to class

Output

Details

getStartIndexInGroupjump to class

Output

Details

setCategoryjump to class

Arguments

Output

Details

setDigestjump to class

Arguments

Output

Details

setGroupedjump to class

Arguments

Output

Details

setMaxResultsGroupjump to class

Arguments

Output

Details

setMaxResultsInGroupjump to class

Arguments

Output

Details

setStartIndexGroupjump to class

Arguments

Output

Details

setStartIndexInGroupjump to class

Arguments

Output

Details

Zend_Gdata_Health_Query
jump to top

HEALTH_PROFILE_FEED_URI
jump to class

HEALTH_REGISTER_FEED_URI
jump to class

ITEM_CATEGORY_NS
jump to class

$_defaultFeedUri
jump to class

getCategory
jump to class

getDigest
jump to class

getGrouped
jump to class

getMaxResultsGroup
jump to class

getMaxResultsInGroup
jump to class

getStartIndexGroup
jump to class

getStartIndexInGroup
jump to class

setCategory
jump to class

setDigest
jump to class

setGrouped
jump to class

setMaxResultsGroup
jump to class

setMaxResultsInGroup
jump to class

setStartIndexGroup
jump to class

setStartIndexInGroup
jump to class