yidas/google-apiclient-helper

Google APIs Client Helper - Easy way to accessing Google APIs with PHP

, _(*1)

Google API Client Helper

Google APIs Client Helper - Easy way to accessing Google APIs with PHP, _(*2)

, _(*3)

FEATURES

• Easy way to develop and manage Google API application, _(*4)

• Documentation supported for Service SDK, _(*5)

• Simple usage for each Service, _(*6)

This Helper is based on google-api-php-client and google-api-php-client-services., _(*7)

OUTLINE

• Demonstration
• Requirements
• Installation
• Google Client
  • Configuration
    • Config Array Method
    • Config Chain Method
    • Encapsulating Method
  • AccessToken Usage
    • refreshAccessToken()
    • verifyAccessToken()
    • verifyScopes()
  • Implementation
• Google Services
  • People
    • Attributes
    • getSimpleContacts()
    • createContact()
    • updateContact()
    • deleteContact()
• Exceptions

- Reference

DEMONSTRATION

$client = \yidas\google\apiHelper\Client::setClient()
    ->setApplicationName('Google API')
    ->setAuthConfig('/path/google_api_secret.json')
    ->setRedirectUri("http://{$_SERVER['HTTP_HOST']}" . dirname($_SERVER['PHP_SELF'])
    ->setAccessToken($accessToken)
    ->getClient();

if ($accessToken = ClientHelper::refreshAccessToken()) {
    // saveAccessToken($accessToken)
}

// People Service uses Google_Client from Client helper above
$contacts = \yidas\google\apiHelper\services\People::getSimpleContacts();

REQUIREMENTS

This library requires the following:, _(*8)

• PHP 5.4.0+
• google/apiclient 2.0+

INSTALLATION

Run Composer in your project:, _(*9)

composer require yidas/google-apiclient-helper

Then you could call it after Composer is loaded depended on your PHP framework:, _(*10)

require __DIR__ . '/vendor/autoload.php';

use yidas\google\apiHelper\Client;

GOOGLE CLIENT

Configuration

There are many way to set Google_Client by Helper:, _(*11)

Config Array Method

The config keys refer to the methods of Google_Client. For exmaple, authConfig refers to Google_Client->setAuthConfig()., _(*12)

$client = \yidas\google\apiHelper\Client::setClient([
        'applicationName' => 'Google API',
        'authConfig' => '/path/google_api_secret.json',
        'redirectUri' => "http://{$_SERVER['HTTP_HOST']}" . dirname($_SERVER['PHP_SELF'],
        ])
    ->getClient();

Config Chain Method

The methods refer to the same method names of Google_Client. For exmaple, setAuthConfig() refers to Google_Client->setAuthConfig()., _(*13)

$client = \yidas\google\apiHelper\Client::setClient()
    ->setApplicationName('Google API')
    ->setAuthConfig('/path/google_api_secret.json')
    ->setRedirectUri("http://{$_SERVER['HTTP_HOST']}" . dirname($_SERVER['PHP_SELF'])
    ->getClient();
````

#### Encapsulating Method

```php
$client = new Google_Client();
$client->setAuthConfig('/path/google_api_secret.json');
\yidas\google\apiHelper\Client::setClient($client);

After encapsulating Google_Client into Helper, the Helper would share with the same Google_Client object., _(*14)

AccessToken Usage

refreshAccessToken()

Simple way to get refreshed access token or false expired to skip, _(*15)

public static array|false refreshAccessToken()

Example:, _(*16)

$client = \yidas\google\apiHelper\Client::setClient()
    ->setApplicationName('Google API')
    ->setAuthConfig('/path/google_api_secret.json')
    ->setRedirectUri("http://{$_SERVER['HTTP_HOST']}" . dirname($_SERVER['PHP_SELF'])
    ->setAccessToken($accessToken)
    ->getClient();

// Simple way to get refreshed access token or false expired to skip
if ($accessToken = ClientHelper::refreshAccessToken()) {
    // saveAccessToken($accessToken)
}

Helper handles the setting setAccessType('offline') & setApprovalPrompt('force') for refresh token., _(*17)

verifyAccessToken()

Verify an access_token. This method will verify the current access_token by Google API, if one isn't provided., _(*18)

public static array|false verifyAccessToken(string $accessToken=null)

verifyScopes()

Verify scopes of tokenInfo by access_token. This method will verify the current access_token by Google API, if one isn't provided., _(*19)

public static array|false verifyScopes(array $scopes, string $accessToken=null)

Example:, _(*20)

$result = \yidas\google\apiHelper\Client::verifyScopes([
    'https://www.googleapis.com/auth/userinfo.profile',
]);

Implementation

There are more implementations such as addScope() or createAuthUrl() for OAuth register, you cloud refer following sample code:, _(*21)

yidas/php-google-api-sample, _(*22)

GOOGLE SERVICES

You could directly use any Service Helpers which uses Google_Client from yidas\google\apiHelper\Client:, _(*23)

use \yidas\google\apiHelper\services\People as PeopleHelper;
\yidas\google\apiHelper\Client::setClient([...])

$contacts = PeopleHelper::getSimpleContacts();

Or you could reset a Google_Client for each Service Helper:, _(*24)

use \yidas\google\apiHelper\services\People as PeopleHelper;

PeopleHelper::setClient($googleClient);
// PeopleHelper::method()...

Use getService() to get back current Google Service object for advanced usage:, _(*25)

$service = \yidas\google\apiHelper\services\People::getService();
// $service->people_connections->...

People

API Document: https://developers.google.com/people/api/rest/, _(*26)

People helper has smart call refered to Google_Service_PeopleService_Person methods, which provides easy interface to setValue() for a person., _(*27)

// Simple setValue() example
\yidas\google\apiHelper\services\People::newPerson
    ->setEmailAddresses('myintaer@gmail.com')
    ->setPhoneNumbers('+886')
    ->setBiographies("I'm a note");

Attributes

It's easy to set attributes for a person by Helper, which provides three types for input data:, _(*28)

1. Origin Object

Input by original Google Attribute Classes that are not so convenience., _(*29)

$gPhoneNumber = new Google_Service_PeopleService_PhoneNumber;
$gPhoneNumber->setValue('+886');
\yidas\google\apiHelper\services\People::setPhoneNumbers($gPhoneNumber);

2. Array

Input by array type would map to the API key-value setting., _(*30)

\yidas\google\apiHelper\services\People::setPhoneNumbers(['value' => '+886']);

3. String

Input by string type would enable Helper attribute handler which automatically settles value for all attributes., _(*31)

\yidas\google\apiHelper\services\People::setPhoneNumbers('+886');

getSimpleContacts()

Get simple contact data with parser, _(*32)

public static array getContacts()

Example:, _(*33)

// Get formated list by Helper
$contacts = \yidas\google\apiHelper\services\People::getSimpleContacts();

Result:, _(*34)

Array
(
    [0] => Array
        (
            [id] => people/c26081557840316580
            [name] => Mr.Nick
            [email] => 
            [phone] => 0912 345 678
        )
    ...

This is simple fields parser, you could use listPeopleConnections() if you need all fields., _(*35)

createContact()

Create a People Contact, _(*36)

public static Google_Service_PeopleService_Person createContact()

Example:, _(*37)

$person = \yidas\google\apiHelper\services\People::newPerson()
    ->setNames('Nick')
    ->setEmailAddresses('myintaer@gmail.com')
    ->setPhoneNumbers('+886')
    ->createContact();

Resource Name: $person->resourceName or $person['resourceName']., _(*38)

updateContact()

Update a People Contact, _(*39)

public static Google_Service_PeopleService_PeopleEmpty updateContact(array $optParams=null)

Example:, _(*40)

$person = \yidas\google\apiHelper\services\People::findByResource($resourceName)
    ->setNames('Nick')
    ->setEmailAddresses('myintaer@gmail.com')
    ->setPhoneNumbers('+886')
    ->updateContact();

deleteContact

Delete a People Contact, _(*41)

public static Google_Service_PeopleService_PeopleEmpty deleteContact(string $resourceName=null, array $optParams=[])

Example:, _(*42)

$person = \yidas\google\apiHelper\services\People::deleteContact($resourceName);

You could also use find pattern:, _(*43)

$person = \yidas\google\apiHelper\services\People::findByResource($resourceName)
    ->deleteContact();

EXCEPTIONS

For all Google Exception including Client and Services:, _(*44)

try {} catch (\Google_Exception $e) {}

Otherwise, for Google Services only:, _(*45)

try {} catch (\Google_Service_Exception $e) {}

REFERENCE

• Google API PHP Client SDK, _(*46)

• Google API PHP Client Serivces SDK, _(*47)

• Google Identity Platform, _(*48)

• Google People API, _(*49)