GoogleOAuth.php 1.85 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\authclient\clients;

use yii\authclient\OAuth2;

/**
 * GoogleOAuth allows authentication via Google OAuth.
Carsten Brandt committed
14 15
 *
 * In order to use Google OAuth you must register your application at <https://code.google.com/apis/console#access>.
16
 *
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
 * Example application configuration:
 *
 * ~~~
 * 'components' => [
 *     'authClientCollection' => [
 *         'class' => 'yii\authclient\Collection',
 *         'clients' => [
 *             'google' => [
 *                 'class' => 'yii\authclient\clients\GoogleOAuth',
 *                 'clientId' => 'google_client_id',
 *                 'clientSecret' => 'google_client_secret',
 *             ],
 *         ],
 *     ]
 *     ...
 * ]
 * ~~~
 *
35 36 37 38 39 40 41 42 43 44 45
 * @see https://code.google.com/apis/console#access
 * @see https://developers.google.com/google-apps/contacts/v3/
 *
 * @author Paul Klimov <klimov.paul@gmail.com>
 * @since 2.0
 */
class GoogleOAuth extends OAuth2
{
	/**
	 * @inheritdoc
	 */
Paul Klimov committed
46 47 48 49 50 51 52 53 54 55 56 57 58 59
	public $authUrl = 'https://accounts.google.com/o/oauth2/auth';
	/**
	 * @inheritdoc
	 */
	public $tokenUrl = 'https://accounts.google.com/o/oauth2/token';
	/**
	 * @inheritdoc
	 */
	public $apiBaseUrl = 'https://www.googleapis.com/oauth2/v1';

	/**
	 * @inheritdoc
	 */
	public function init()
60
	{
61
		parent::init();
Paul Klimov committed
62 63 64 65 66 67
		if ($this->scope === null) {
			$this->scope = implode(' ', [
				'https://www.googleapis.com/auth/userinfo.profile',
				'https://www.googleapis.com/auth/userinfo.email',
			]);
		}
68 69 70 71 72 73 74
	}

	/**
	 * @inheritdoc
	 */
	protected function initUserAttributes()
	{
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
		return $this->api('userinfo', 'GET');
	}

	/**
	 * @inheritdoc
	 */
	protected function defaultName()
	{
		return 'google';
	}

	/**
	 * @inheritdoc
	 */
	protected function defaultTitle()
	{
		return 'Google';
92 93
	}
}