API Documentation

Gdata/Health.php

Includes Classes 
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: Health.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Gdata_Health

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

Extends from
Zend_Gdata
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
AUTHSUB_PROFILE_FEED_URI
AUTHSUB_REGISTER_FEED_URI
CLIENTLOGIN_PROFILELIST_FEED_URI
CLIENTLOGIN_PROFILE_FEED_URI
CLIENTLOGIN_REGISTER_FEED_URI
HEALTH_SERVICE_NAME
H9_SANDBOX_SERVICE_NAME
Properties
$_profileID
$_useH9Sandbox
$namespaces
Methods
__construct
getProfileID
setProfileID
getHealthProfileListFeed
getHealthProfileFeed
getHealthProfileEntry
sendHealthNotice

Description

Service class for interacting with the Google Health Data API

Constants

AUTHSUB_PROFILE_FEED_URI

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

URIs of the AuthSub/OAuth feeds.

Details

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

AUTHSUB_REGISTER_FEED_URI

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

Details

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

CLIENTLOGIN_PROFILELIST_FEED_URI

 CLIENTLOGIN_PROFILELIST_FEED_URI = 'https://www.google.com/health/feeds/profile/list'

URIs of the ClientLogin feeds.

Details

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

CLIENTLOGIN_PROFILE_FEED_URI

 CLIENTLOGIN_PROFILE_FEED_URI = 'https://www.google.com/health/feeds/profile/ui'

Details

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

CLIENTLOGIN_REGISTER_FEED_URI

 CLIENTLOGIN_REGISTER_FEED_URI = 'https://www.google.com/health/feeds/register/ui'

Details

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

HEALTH_SERVICE_NAME

 HEALTH_SERVICE_NAME = 'health'

Authentication service names for Google Health and the H9 Sandbox.

Details

value
health

H9_SANDBOX_SERVICE_NAME

 H9_SANDBOX_SERVICE_NAME = 'weaver'

Details

value
weaver

Properties

$_profileID

string $_profileID = 'null'

Profile ID used for all API interactions. This can only be set when using ClientLogin for authentication.

Details

$_profileID
string
visibility
private
default
null
final
false
static
false

$_useH9Sandbox

bool $_useH9Sandbox = 'false'

True if API calls should be made to the H9 developer sandbox at /h9 rather than /health

Details

$_useH9Sandbox
bool
visibility
private
default
false
final
false
static
false

$namespaces

 $namespaces = 'array'

Details

visibility
public
default
array
final
false
static
true

Methods

__construct

__construct( Zend_Http_Client $client = null, string $applicationId = MyCompany-MyApp-1.0, bool $useH9Sandbox = false ) :

Create Zend_Gdata_Health object

Arguments
$client
Zend_Http_Client
(optional) The HTTP client to use when when communicating with the Google Health servers.
$applicationId
string
The identity of the application in the form of Company-AppName-Version
$useH9Sandbox
bool
True if the H9 Developer's Sandbox should be used instead of production Google Health.
Details
visibility
public
final
false
static
false

getHealthProfileEntry

getHealthProfileEntry( mixed $query = null ) : Zend_Gdata_Health_ProfileEntry

Retrieve a profile entry object

Arguments
$query
mixed
The query for the feed, as a URL or Query
Details
visibility
public
final
false
static
false

getHealthProfileFeed

getHealthProfileFeed( mixed $query = null ) : Zend_Gdata_Health_ProfileFeed

Retrieve a user's profile as a feed object. If ClientLogin is used, the profile associated with $this->_profileID is returned, otherwise the profile associated with the AuthSub token is read.

Arguments
$query
mixed
The query for the feed, as a URL or Query
Details
visibility
public
final
false
static
false

getHealthProfileListFeed

getHealthProfileListFeed( string $query = null ) : Zend_Gdata_Feed

Retrieves the list of profiles associated with the user's ClientLogin credentials.

Arguments
$query
string
The query of the feed as a URL or Query object
Details
visibility
public
final
false
static
false

getProfileID

getProfileID( ) : string

Gets the id of the user's profile

Output
string
The profile id
Details
visibility
public
final
false
static
false

sendHealthNotice

sendHealthNotice( string $subject, string $body, string $bodyType = null, string $ccrXML = null ) : Zend_Gdata_Health_ProfileEntry

Posts a new notice using the register feed. This function constructs the atom profile entry.

Arguments
$subject
string
The subject line of the notice
$body
string
The message body of the notice
$bodyType
string
The (optional) type of message body (text, xhtml, html, etc.)
$ccrXML
string
The (optional) CCR to add to the user's profile
Details
visibility
public
final
false
static
false

setProfileID

setProfileID( string $id ) : Zend_Gdata_Health

Sets which of the user's profiles will be used

Arguments
$id
string
The profile ID
Output
Zend_Gdata_Health
Provides a fluent interface
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.