| Inheritance | yii\authclient\clients\GitHub » yii\authclient\OAuth2 » yii\authclient\BaseOAuth » yii\authclient\BaseClient » yii\base\Component » yii\base\Object |
|---|---|
| Implements | yii\authclient\ClientInterface, yii\base\Configurable |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-authclient/blob/master/clients/GitHub.php |
GitHub allows authentication via GitHub OAuth.
In order to use GitHub OAuth you must register your application at https://github.com/settings/applications/new.
Example application configuration:
'components' => [
'authClientCollection' => [
'class' => 'yii\authclient\Collection',
'clients' => [
'github' => [
'class' => 'yii\authclient\clients\GitHub',
'clientId' => 'github_client_id',
'clientSecret' => 'github_client_secret',
],
],
]
...
]
See also:
API base URL. This field will be used as yii\httpclient\Client::$baseUrl value of $httpClient. Note: changing this property will take no effect after $httpClient is instantiated.
public string $apiBaseUrl = 'https://api.github.com'
Authorize URL.
public string $authUrl = 'https://github.com/login/oauth/authorize'
Token request URL endpoint.
public string $tokenUrl = 'https://github.com/login/oauth/access_token'
Generates service name.
| protected string defaultName ( ) | ||
|---|---|---|
| return | string |
Service name. |
Generates service title.
| protected string defaultTitle ( ) | ||
|---|---|---|
| return | string |
Service title. |
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
| public void init ( ) |
|---|
Initializes authenticated user attributes.
| protected array initUserAttributes ( ) | ||
|---|---|---|
| return | array |
Auth user attributes. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-authclient-clients-github.html