Flexmls OAuth2 提供者用于 Laravel Socialite

4.0.0 2021-02-24 22:46 UTC

This package is auto-updated.

Last update: 2024-08-26 21:31:09 UTC


README

Laravel Socialite 提供者,用于 FlexMLS Spark 平台

composer require socialiteproviders/flexmls

安装与基本使用

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

config/services.php 中添加配置

'flexmls' => [    
  'client_id' => env('SPARKPLATFORM_CLIENT_ID'),  
  'client_secret' => env('SPARKPLATFORM_CLIENT_SECRET'),  
  'redirect' => env('SPARKPLATFORM_REDIRECT_URI')
],

添加提供者事件监听器

Laravel 11+

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

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

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

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

使用方法

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

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

请注意,所有对 Spark API 的请求 都需要存在 X-SparkApi-User-Agent 标头,否则请求将因 400 错误而失败。

返回的用户字段

  • id
  • name
  • email

该提供者还将返回整个用户资料文档,作为 SocialiteProviders\Manager\OAuth2\User 对象中的 user 数组。

许可证

MIT