On this page
Class yii\authclient\clients\Google
Inheritance | yii\authclient\clients\Google » yii\authclient\OAuth2 » yii\authclient\BaseOAuth » yii\authclient\BaseClient » yii\base\Component » yii\base\Object |
---|---|
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/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
Example application configuration:
'components' => [
'authClientCollection' => [
'class' => 'yii\authclient\Collection',
'clients' => [
'google' => [
'class' => 'yii\authclient\clients\Google',
'clientId' => 'google_client_id',
'clientSecret' => 'google_client_secret',
],
],
]
...
]
See also https://console.developers.google.com/project.
Public Properties
Public Methods
Protected Methods
Property Details
$apiBaseUrl public property
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://www.googleapis.com/plus/v1'
$authUrl public property
Authorize URL.
public string $authUrl = 'https://accounts.google.com/o/oauth2/auth'
$tokenUrl public property
Token request URL endpoint.
public string $tokenUrl = 'https://accounts.google.com/o/oauth2/token'
Method Details
defaultName() protected method
Generates service name.
protected string defaultName ( ) | ||
---|---|---|
return | string | Service name. |
defaultTitle() protected method
Generates service title.
protected string defaultTitle ( ) | ||
---|---|---|
return | string | Service title. |
init() public method
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 ( ) |
---|
initUserAttributes() protected method
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-google.html