Class yii\authclient\clients\GitHub
| Inheritance | yii\authclient\clients\GitHub » yii\authclient\OAuth2 » yii\authclient\BaseOAuth » yii\authclient\BaseClient » yii\base\Component » yii\base\BaseObject |
|---|---|
| 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/developers.
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:
Public Properties
Public Methods
Protected Methods
Property Details
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.
Authorize URL.
Token request URL endpoint.
Method Details
Applies access token to the HTTP request instance.
| public void applyAccessTokenToRequest ( $request, $accessToken ) | ||
| $request | yii\httpclient\Request | HTTP request instance. |
| $accessToken | yii\authclient\OAuthToken | Access token instance. |
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. |
|---|---|---|