Gdata/Health.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: Health.php 23775 2011-03-01 17:25:24Z ralph $
Service class for interacting with the
Google Health Data API
As the Google data API protocol is based upon the Atom Publishing
Protocol (APP), Gdata functionality extends the appropriate
Zend_Gdata_App classes
- Extends from
- \Zend_Gdata
- 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 $_profileID=
'null'
Profile ID used for all API
interactions. This can only be set when using ClientLogin for
authentication.
Default valuenull
Details
- Type
- string



bool $_useH9Sandbox=
'false'
True if API calls should be made to the
H9 developer sandbox at /h9 rather than /health
Default valuefalse
Details
- Type
- bool



array $namespaces=
'array'
static
Namespaces used for Gdata data
Default valuearray
Details
- Type
- array
Methods



__call( string $method, array $args ) : void
Provides a magic factory method to
instantiate new objects with shorter syntax than would otherwise be
required by the Zend Framework naming conventions. For instance, to
construct a new Zend_Gdata_Calendar_Extension_Color, a developer simply
needs to do $gCal->newColor(). For this magic constructor, packages are
searched in the same order as which they appear in the
$_registeredPackages array
Inherited from: \Zend_Gdata_App::__call()
Parameters
Name |
Type |
Description |
$method |
string |
The method name being called |
$args |
array |
The arguments passed to the call |
Throws



__construct( \Zend_Http_Client $client
= null, string $applicationId = MyCompany-MyApp-1.0, bool $useH9Sandbox
= false ) : void
Create Zend_Gdata_Health object
Parameters
Name |
Type |
Description |
$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.
|



get( string $uri, array $extraHeaders = array
) : \Zend_Http_Response
Parameters
Name |
Type |
Description |
$uri |
string |
GET URI |
$extraHeaders |
array |
Extra headers to add to the request, as an array of
string-based key/value pairs.
|
Returns
Throws



getHealthProfileEntry( mixed $query = null ) : \Zend_Gdata_Health_ProfileEntry
Retrieve a profile entry object
Parameters
Name |
Type |
Description |
$query |
mixed |
The query for the feed, as a URL or Query |
Returns



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.
Parameters
Name |
Type |
Description |
$query |
mixed |
The query for the feed, as a URL or Query |
Returns



getHealthProfileListFeed( string $query = null ) : \Zend_Gdata_Feed
Retrieves the list of profiles
associated with the user's ClientLogin credentials.
Parameters
Name |
Type |
Description |
$query |
string |
The query of the feed as a URL or Query object |
Returns



getProfileID( ) : string
Gets the id of the user's profile
Returns
Type |
Description |
string |
The profile id |



importUrl( string $url, string $className =
Zend_Gdata_App_Feed, array $extraHeaders = array ) : string|\Zend_Gdata_App_Feed
Parameters
Name |
Type |
Description |
$url |
string |
The URL to import |
$className |
string |
The class which is used as the return type |
$extraHeaders |
array |
Extra headers to add to the request, as an array of
string-based key/value pairs.
|
Returns
Type |
Description |
string\Zend_Gdata_App_Feed
|
Returns string only if the object mapping has been disabled
explicitly by passing false to the useObjectMapping() function. |
Throws



insertEntry( mixed $data, string $uri,
string $className = Zend_Gdata_App_Entry, array $extraHeaders = array )
: \Zend_Gdata_App_Entry
Parameters
Name |
Type |
Description |
$data |
mixed |
The Zend_Gdata_App_Entry or XML to post |
$uri |
string |
POST URI |
$className |
string |
The class of entry to be returned. |
$extraHeaders |
array |
Extra headers to add to the request, as an array of
string-based key/value pairs.
|
Returns



performHttpRequest( string $method, string $url,
array $headers = array, string $body = null, string $contentType = null,
int $remainingRedirects = null ) : \Zend_Http_Response
Overrides the definition in the parent (Zend_Gdata_App) and uses
the Zend_Gdata_HttpClient functionality to filter the HTTP requests and
responses.
Parameters
Name |
Type |
Description |
$method |
string |
The HTTP method for the request - 'GET', 'POST', 'PUT',
'DELETE'
|
$url |
string |
The URL to which this request is being performed, or null if
found in $data
|
$headers |
array |
An associative array of HTTP headers for this
request |
$body |
string |
The body of the HTTP request |
$contentType |
string |
The value for the content type of the request body |
$remainingRedirects |
int |
Number of redirects to follow if requests results in
one |
Returns



post( mixed $data, string $uri = null,
$remainingRedirects = null, string $contentType = null,
array $extraHeaders = null ) : \Zend_Http_Response
Parameters
Name |
Type |
Description |
$data |
mixed |
The Zend_Gdata_App_Entry or XML to post |
$uri |
string |
POST URI |
$remainingRedirects |
|
|
$contentType |
string |
Content-type of the data
|
$extraHeaders |
array |
Extra headers to add to the request, as an array of
string-based key/value pairs.
|
Returns
Throws



prepareRequest( string $method, string $url = null,
array $headers = array, mixed $data = null, string $contentTypeOverride
= null ) : array
- Checks the $data element and, if it's an entry, extracts the
XML, multipart data, edit link (PUT,DELETE), etc.
- If $data is a string, sets the default content-type header as
'application/atom+xml' if it's not already been set.
- Adds a x-http-method override header and changes the HTTP
method to 'POST' if necessary as per getHttpMethodOverride()
Parameters
Name |
Type |
Description |
$method |
string |
The HTTP method for the request - 'GET', 'POST', 'PUT',
'DELETE'
|
$url |
string |
The URL to which this request is being performed, or null if
found in $data
|
$headers |
array |
An associative array of HTTP headers for this
request |
$data |
mixed |
The Zend_Gdata_App_Entry or XML for the body of the
request |
$contentTypeOverride |
string |
The override value for the content type of the
request body |
Returns
Type |
Description |
array |
An associative array containing the determined 'method',
'url', 'data', 'headers', 'contentType' |



put( mixed $data, string $uri = null,
$remainingRedirects = null, string $contentType = null,
array $extraHeaders = null ) : \Zend_Http_Response
Parameters
Name |
Type |
Description |
$data |
mixed |
The Zend_Gdata_App_Entry or XML to post |
$uri |
string |
PUT URI |
$remainingRedirects |
|
|
$contentType |
string |
Content-type of the data
|
$extraHeaders |
array |
Extra headers to add to the request, as an array of
string-based key/value pairs.
|
Returns
Throws



registerPackage( string $name ) : void
This array is searched when using the magic __call method below
to instantiante new objects.
Parameters
Name |
Type |
Description |
$name |
string |
The name of the package (eg Zend_Gdata_App)
|



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.
Parameters
Name |
Type |
Description |
$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
|
Returns



setMinorProtocolVersion( \(int|\NULL) $value ) : void
Set the minor protocol version that
should be used. If set to NULL, no minor protocol version will be sent
to the server. Values < 0 will cause a
Zend_Gdata_App_InvalidArgumentException to be thrown.
Inherited from: \Zend_Gdata_App::setMinorProtocolVersion()
Parameters
Name |
Type |
Description |
$value |
\(int|\NULL) |
The minor protocol version to use. |
Throws
Details
- see
- \_minorProtocolVersion



setProfileID( string $id ) : \Zend_Gdata_Health
Sets which of the user's profiles will
be used
Parameters
Name |
Type |
Description |
$id |
string |
The profile ID |
Returns



updateEntry( mixed $data, string|null $uri = null,
string|null $className = null, array $extraHeaders = array ) : \Zend_Gdata_App_Entry
Parameters
Name |
Type |
Description |
$data |
mixed |
Zend_Gdata_App_Entry or XML (w/ID and link rel='edit')
|
$uri |
string|null |
The URI to send requests to, or null if $data contains the URI.
|
$className |
string|null |
The name of the class that should be deserialized from the
server response. If null, then 'Zend_Gdata_App_Entry' will be used.
|
$extraHeaders |
array |
Extra headers to add to the request, as an array of
string-based key/value pairs.
|
Returns
Throws