Moodle  2.2.1
http://www.collinsharper.com
Zend_Gdata_Health Class Reference
Inheritance diagram for Zend_Gdata_Health:
Collaboration diagram for Zend_Gdata_Health:

Public Member Functions

 __construct ($client=null, $applicationId= 'MyCompany-MyApp-1.0', $useH9Sandbox=false)
 getProfileID ()
 setProfileID ($id)
 getHealthProfileListFeed ($query=null)
 getHealthProfileFeed ($query=null)
 getHealthProfileEntry ($query=null)
 sendHealthNotice ($subject, $body, $bodyType=null, $ccrXML=null)

Data Fields

const AUTHSUB_PROFILE_FEED_URI
const AUTHSUB_REGISTER_FEED_URI
const CLIENTLOGIN_PROFILELIST_FEED_URI
const CLIENTLOGIN_PROFILE_FEED_URI
const CLIENTLOGIN_REGISTER_FEED_URI
const HEALTH_SERVICE_NAME = 'health'
const H9_SANDBOX_SERVICE_NAME = 'weaver'

Static Public Attributes

static $namespaces

Detailed Description

Definition at line 60 of file Health.php.


Constructor & Destructor Documentation

__construct ( client = null,
applicationId = 'MyCompany-MyApp-1.0',
useH9Sandbox = false 
)

Create Zend_Gdata_Health object

Parameters:
Zend_Http_Client$client(optional) The HTTP client to use when when communicating with the Google Health servers.
string$applicationIdThe identity of the application in the form of Company-AppName-Version
bool$useH9SandboxTrue if the H9 Developer's Sandbox should be used instead of production Google Health.

Definition at line 119 of file Health.php.

Here is the call graph for this function:


Member Function Documentation

getHealthProfileEntry ( query = null)

Retrieve a profile entry object

Parameters:
mixed$queryThe query for the feed, as a URL or Query
Returns:
Zend_Gdata_Health_ProfileEntry

Definition at line 221 of file Health.php.

Here is the call graph for this function:

getHealthProfileFeed ( query = null)

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.

Parameters:
mixed$queryThe query for the feed, as a URL or Query
Returns:
Zend_Gdata_Health_ProfileFeed

Definition at line 187 of file Health.php.

Here is the call graph for this function:

getHealthProfileListFeed ( query = null)

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

Parameters:
string$queryThe query of the feed as a URL or Query object
Returns:
Zend_Gdata_Feed

Definition at line 155 of file Health.php.

Here is the call graph for this function:

Gets the id of the user's profile

Returns:
string The profile id

Definition at line 132 of file Health.php.

Here is the caller graph for this function:

sendHealthNotice ( subject,
body,
bodyType = null,
ccrXML = null 
)

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

Parameters:
string$subjectThe subject line of the notice
string$bodyThe message body of the notice
string$bodyTypeThe (optional) type of message body (text, xhtml, html, etc.)
string$ccrXMLThe (optional) CCR to add to the user's profile
Returns:
Zend_Gdata_Health_ProfileEntry

Definition at line 246 of file Health.php.

Here is the call graph for this function:

setProfileID ( id)

Sets which of the user's profiles will be used

Parameters:
string$idThe profile ID
Returns:
Zend_Gdata_Health Provides a fluent interface

Definition at line 143 of file Health.php.


Field Documentation

$namespaces [static]
Initial value:
        array('ccr' => 'urn:astm-org:CCR',
              'batch' => 'http://schemas.google.com/gdata/batch',
              'h9m' => 'http://schemas.google.com/health/metadata',
              'gAcl' => 'http://schemas.google.com/acl/2007',
              'gd' => 'http://schemas.google.com/g/2005')

Reimplemented from Zend_Gdata.

Definition at line 102 of file Health.php.

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

URIs of the AuthSub/OAuth feeds.

Definition at line 65 of file Health.php.

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

Definition at line 67 of file Health.php.

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

Definition at line 75 of file Health.php.

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

URIs of the ClientLogin feeds.

Definition at line 73 of file Health.php.

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

Definition at line 77 of file Health.php.

const H9_SANDBOX_SERVICE_NAME = 'weaver'

Definition at line 84 of file Health.php.

const HEALTH_SERVICE_NAME = 'health'

Authentication service names for Google Health and the H9 Sandbox.

Definition at line 83 of file Health.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations