Class yii\authclient\clients\Google
| Inheritance | yii\authclient\clients\Google » yii\authclient\OAuth2 » yii\authclient\BaseOAuth » yii\authclient\BaseClient » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | yii\authclient\ClientInterface, yii\base\Configurable |
| Subclasses | yii\authclient\clients\GoogleHybrid |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-authclient/blob/master/clients/Google.php |
Google allows authentication via Google OAuth.
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/apis/credentials?project=[yourProjectId].
Example application configuration:
'components' => [
'authClientCollection' => [
'class' => 'yii\authclient\Collection',
'clients' => [
'google' => [
'class' => 'yii\authclient\clients\Google',
'clientId' => 'google_client_id',
'clientSecret' => 'google_client_secret',
],
],
]
// ...
]
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
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. |
|---|---|---|