Inheritance | yii\authclient\clients\Facebook » 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/Facebook.php |
Facebook allows authentication via Facebook OAuth.
In order to use Facebook OAuth you must register your application at https://developers.facebook.com/apps.
Example application configuration:
'components' => [ 'authClientCollection' => [ 'class' => 'yii\authclient\Collection', 'clients' => [ 'facebook' => [ 'class' => 'yii\authclient\clients\Facebook', 'clientId' => 'facebook_client_id', 'clientSecret' => 'facebook_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://graph.facebook.com'
List of attribute names, which should be requested from API to initialize user attributes.
public array $attributeNames = ['name', 'email']
Authorize URL.
public string $authUrl = 'https://www.facebook.com/dialog/oauth'
Auth request scope.
public string $scope = 'email'
Token request URL endpoint.
public string $tokenUrl = 'https://graph.facebook.com/oauth/access_token'
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. |
Returns the default $viewOptions value.
Particular client may override this method in order to provide specific default view options.
protected array defaultViewOptions ( ) | ||
---|---|---|
return | array |
List of default $viewOptions |
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-facebook.html