Skip to content

Commit

Permalink
Converting the docbook stragglers to markdown.
Browse files Browse the repository at this point in the history
  • Loading branch information
LouisLandry committed Nov 11, 2012
1 parent 654ca91 commit b87a103
Show file tree
Hide file tree
Showing 5 changed files with 265 additions and 378 deletions.
81 changes: 0 additions & 81 deletions docs/manual/en-US/chapters/classes/jkeychain.xml

This file was deleted.

79 changes: 79 additions & 0 deletions docs/manual/en-US/chapters/packages/google.md
@@ -0,0 +1,79 @@
## The Google Package

### Using the Google Package

The Google package is designed to be a straightforward interface for working with various Google APIs. You can find a list of APIs and documentation for each API at [https://developers.google.com/products/.](https://developers.google.com/products/)

#### Instantiating JGoogle

Instantiating JGoogle is easy:

```php
$google = new JGoogle;
```

This creates a generic JGoogle object that can be used to instantiate objects for specific Google APIs.

Sometimes it is necessary to specify additional options. This can be done by injecting in a JRegistry object with your preferred options:

```php
$options = new JRegistry;
$options->set('clientid', 'google_client_id.apps.googleusercontent.com');
$options->set('clientsecret', 'google_client_secret');

$google = new JGoogle($options);
```

#### Accessing the JGoogle APIs

The Google Package divides APIs into two types: data APIs and embed APIs. Data APIs use JHttp to send and receive data from Google. Embed APIs output HTML, JavaScript, and XML in order to embed information from Google in a webpage.

The Google package is still incomplete, but there are five object APIs that have currently been implemented:

Data: Google Calendar, Google AdSense, Google Picasa

Data: Google Maps, Google Analytics

Once a JGoogle object has been created, it is simple to use it to create objects for each individual API:

```php
$calendar = $google->data('calendar');
```

or

```php
$analytics = $google->data('analytics');
```

#### Using an API

See below for an example demonstrating the use of the Calendar API:

```php
$options = new JRegistry;

// Client ID and Client Secret can be obtained through the Google API Console (https://code.google.com/apis/console/).
$options->set('clientid', 'google_client_id.apps.googleusercontent.com');
$options->set('clientsecret', 'google_client_secret');
$options->set('redirecturi', JURI::current());

$google = new JGoogle($options);

// Get a calendar API object
$calendar = $google->data('calendar');

// If the client hasn't been authenticated via OAuth yet, redirect to the appropriate URL and terminate the program
if (!$calendar->isAuth())
{
JResponse::sendHeaders();
die();
}

// Create a new Google Calendar called "Hello World."
$calendar->createCalendar('Hello World');
```

#### More Information

The following resources contain more information:[Joomla! API Reference](http://api.joomla.org), [Google Developers Homepage](https://developers.google.com/)
95 changes: 0 additions & 95 deletions docs/manual/en-US/chapters/packages/google.xml

This file was deleted.

0 comments on commit b87a103

Please sign in to comment.