Laravel Socialite 的 VATSIM OAuth2 提供者

5.0.0 2022-10-21 22:12 UTC

This package is auto-updated.

Last update: 2024-08-26 21:43:57 UTC


README

composer require socialiteproviders/vatsim

安装与基本用法

请参阅基础安装指南,然后按照以下特定提供者的说明操作。

将配置添加到 config/services.php

'vatsim' => [
  'client_id' => env('VATSIM_CLIENT_ID'),
  'client_secret' => env('VATSIM_CLIENT_SECRET'),
  'redirect' => env('VATSIM_REDIRECT_URI'),
  'test' => env('VATSIM_TEST'),
],

请参阅配置 VATSIM Connect 认证

添加提供者事件监听器

Laravel 11+

在 Laravel 11 中,默认的 EventServiceProvider 提供者已被移除。相反,您可以在 AppServiceProviderboot 方法中使用 Event 门面上的 listen 方法添加监听器。

  • 注意:除非您用自己的提供者覆盖它们,否则您不需要为内置的 socialite 提供者添加任何内容。
Event::listen(function (\SocialiteProviders\Manager\SocialiteWasCalled $event) {
    $event->extendSocialite('vatsim', \SocialiteProviders\Vatsim\Provider::class);
});
Laravel 10 或以下配置包的监听器以监听 `SocialiteWasCalled` 事件。

将事件添加到您的 app/Providers/EventServiceProvider 中的 listen[] 数组中。有关详细说明,请参阅基础安装指南

protected $listen = [
    \SocialiteProviders\Manager\SocialiteWasCalled::class => [
        // ... other providers
        \SocialiteProviders\Vatsim\VatsimExtendSocialite::class.'@handle',
    ],
];

用法

现在您应该能够像通常使用 Socialite 一样使用提供者(假设您已安装了门面)

return Socialite::driver('vatsim')->redirect();

要向您的认证添加作用域,可以使用以下方法

return Socialite::driver('vatsim')->scopes(['full_name', 'email', 'vatsim_details', 'country'])->redirect();

要添加必需的作用域(用户无法选择退出的作用域)到您的认证,可以使用以下方法

return Socialite::driver('vatsim')->requiredScopes(['email'])->redirect();

返回的用户字段

  • cid
  • first_name
  • last_name
  • full_name
  • email
  • rating
  • pilotrating
  • region
  • division
  • subdivision