yii2-extension yii2-google-apiclient

bscheshirwork/yii2-google-apiclient

A Yii2 wrapper for the official Google API PHP Client

A Yii2 wrapper for the official Google API PHP Client., _(*1)

This extension features:, _(*2)

• A console utility to generate your credentials files
• A component that will take care of the authentication, and give you access to the service

Installation

The preferred way to install this extension is through composer., _(*3)

Either run, _(*4)

php composer.phar require --prefer-dist bscheshirwork/yii2-google-apiclient "*"

or add, _(*5)

"bscheshirwork/yii2-google-apiclient": "*"

to the require section of your composer.json file., _(*6)

This package will also install the google/apiclient library., _(*7)

Configuration

Credentials file, _(*8)

In order to use this extension, you will be needing a credentials file for your Google Application., _(*9)

You can generate this file using the provided console utility:, _(*10)

• Configure the module in config/console.php:

'bootstrap' => ['log', 'google_apiclient'],
'modules' => [
    'google_apiclient' => [
        'class' => 'bscheshirwork\yii2\google\apiclient\Module',
    ],
],

• Use the /configure sub command:

./yii google_apiclient/configure <clientSecretPath> [api]

where clientSecretPath is the path to your secret JSON file obtained from the Google Console and api the api identifier (it will be prompted for if not provided)., _(*11)

Components, _(*12)

You application may use as much Google_Service instances as you need, by adding an entry into the components index of the Yii configuration array., _(*13)

Here's how to setup GMail for example, a usage sample is provided below., _(*14)

    'components' => [
        // ..
        'gmail' => [
            'class' => 'bscheshirwork\yii2\google\apiclient\components\GoogleApiClient',
            'credentialsPath' => '@runtime/google-apiclient/auth.json',
            'clientSecretPath' => '@runtime/google-apiclient/gmail.json',
            'api' => Google_Service_Gmail::class,
        ],

This will enable you to access the GMail authenticated service Yii::$app->gmail->getService() in your application., _(*15)

Usage

Displaying your newest message subject on GMail, _(*16)

/**
 * @var $service Google_Service_Gmail
 */
$service = Yii::$app->gmail->getService();

$messages = $service->users_messages->listUsersMessages('me', [
    'maxResults' => 1,
    'labelIds' => 'INBOX',
]);
$list = $messages->getMessages();


if (count($list) == 0) {
    echo "You have no emails in your INBOX .. how did you achieve that ??";
} else {
    $messageId = $list[0]->getId(); // Grab first Message

    $message = $service->users_messages->get('me', $messageId, ['format' => 'full']);

    $messagePayload = $message->getPayload();
    $headers = $messagePayload->getHeaders();

    echo "Your last email subject is: ";
    foreach ($headers as $header) {
        if ($header->name == 'Subject') {
            echo "<b>" . $header->value . "</b>";
        }
    }

}

This documentation is available online, _(*17)