GoogleOAuth.php 2.18 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 16 17 18
 * In order to use Google OAuth you must create a project at <https://console.developers.google.com/project>
 * and setup its credentials at <https://console.developers.google.com/project/[yourProjectId]/apiui/credential>.
 * In order to enable using scopes for retrieving user attributes, you should also enable Google+ API at
 * <https://console.developers.google.com/project/[yourProjectId]/apiui/api/plus>
19
 *
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
 * Example application configuration:
 *
 * ~~~
 * 'components' => [
 *     'authClientCollection' => [
 *         'class' => 'yii\authclient\Collection',
 *         'clients' => [
 *             'google' => [
 *                 'class' => 'yii\authclient\clients\GoogleOAuth',
 *                 'clientId' => 'google_client_id',
 *                 'clientSecret' => 'google_client_secret',
 *             ],
 *         ],
 *     ]
 *     ...
 * ]
 * ~~~
 *
38
 * @see https://console.developers.google.com/project
39 40 41 42 43 44
 *
 * @author Paul Klimov <klimov.paul@gmail.com>
 * @since 2.0
 */
class GoogleOAuth extends OAuth2
{
45 46 47 48 49 50 51 52 53 54 55
    /**
     * @inheritdoc
     */
    public $authUrl = 'https://accounts.google.com/o/oauth2/auth';
    /**
     * @inheritdoc
     */
    public $tokenUrl = 'https://accounts.google.com/o/oauth2/token';
    /**
     * @inheritdoc
     */
56
    public $apiBaseUrl = 'https://www.googleapis.com/plus/v1';
Paul Klimov committed
57

58 59 60 61 62 63 64 65
    /**
     * @inheritdoc
     */
    public function init()
    {
        parent::init();
        if ($this->scope === null) {
            $this->scope = implode(' ', [
66 67
                'profile',
                'email',
68 69 70
            ]);
        }
    }
71

72 73 74 75 76
    /**
     * @inheritdoc
     */
    protected function initUserAttributes()
    {
77
        return $this->api('people/me', 'GET');
78
    }
79

80 81 82 83 84 85 86
    /**
     * @inheritdoc
     */
    protected function defaultName()
    {
        return 'google';
    }
87

88 89 90 91 92 93 94
    /**
     * @inheritdoc
     */
    protected function defaultTitle()
    {
        return 'Google';
    }
AlexGx committed
95
}