GitHub.php 1.91 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;

/**
 * GitHub allows authentication via GitHub OAuth.
Carsten Brandt committed
14 15
 *
 * In order to use GitHub OAuth you must register your application at <https://github.com/settings/applications/new>.
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' => [
 *             'github' => [
 *                 'class' => 'yii\authclient\clients\GitHub',
 *                 'clientId' => 'github_client_id',
 *                 'clientSecret' => 'github_client_secret',
 *             ],
 *         ],
 *     ]
 *     ...
 * ]
 * ~~~
 *
35 36 37 38 39 40 41 42
 * @see http://developer.github.com/v3/oauth/
 * @see https://github.com/settings/applications/new
 *
 * @author Paul Klimov <klimov.paul@gmail.com>
 * @since 2.0
 */
class GitHub extends OAuth2
{
43 44 45 46 47 48 49 50 51 52 53 54
    /**
     * @inheritdoc
     */
    public $authUrl = 'https://github.com/login/oauth/authorize';
    /**
     * @inheritdoc
     */
    public $tokenUrl = 'https://github.com/login/oauth/access_token';
    /**
     * @inheritdoc
     */
    public $apiBaseUrl = 'https://api.github.com';
55

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

70 71 72 73 74 75 76
    /**
     * @inheritdoc
     */
    protected function initUserAttributes()
    {
        return $this->api('user', 'GET');
    }
77

78 79 80 81 82 83 84
    /**
     * @inheritdoc
     */
    protected function defaultName()
    {
        return 'github';
    }
85

86 87 88 89 90 91 92
    /**
     * @inheritdoc
     */
    protected function defaultTitle()
    {
        return 'GitHub';
    }
AlexGx committed
93
}