Laravel Socialite 的 USOS OAuth1 提供者

5.0.0 2023-02-21 22:33 UTC

This package is auto-updated.

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


README

composer require socialiteproviders/usos

安装与基本使用

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

将配置添加到 config/services.php

'usos' => [
  'domain' => env('USOS_DOMAIN_URL'), // Because of every instance of USOS is self-hosted
  'client_id' => env('USOS_CLIENT_ID'),
  'client_secret' => env('USOS_CLIENT_SECRET'),
  'redirect' => env('USOS_REDIRECT_URI')
],

默认情况下,提供者只加载 Socialite 数据所需的必要部分。如果您需要在认证过程中获取更多数据,例如学生状态或电话号码,您可能需要添加 profile_fields_selector 参数

'usos' => [
  // ...
  'profile_fields_selector' => env('USOS_PROFILE_FIELDS_SELECTOR'),
  // ...
]

某些字段可能在没有指定 scopes 字段的情况下不可用。

添加提供者事件监听器

Laravel 11+

在 Laravel 11 中,默认的 EventServiceProvider 提供者已被移除。取而代之的是,在您的 AppServiceProviderboot 方法中使用 Event 门面上的 listen 方法添加监听器。

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

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

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

使用方法

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

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

您还可以通过 Socialite 的 scopes 方法使用 USOS 范围

return Socialite::driver('usos')
    ->scopes(['personal', 'email'])
    ->redirect();

有关 scopes 的更多信息,您可以访问您的 USOS 实例的文档页面,或者访问 USOSapi 主服务器网页