socialiteproviders / harid
HarID OAuth2 提供程序,用于 Laravel Socialite
4.0.0
2021-11-04 04:45 UTC
Requires
- php: ^7.2 || ^8.0
- ext-json: *
- socialiteproviders/manager: ~4.0
This package is auto-updated.
Last update: 2024-08-26 21:32:48 UTC
README
composer require socialiteproviders/harid
安装与基本使用
请参阅基本安装指南,然后按照以下特定提供程序的说明进行操作。
将配置添加到 config/services.php
'harid' => [ 'client_id' => env('HARID_CLIENT_ID'), 'client_secret' => env('HARID_CLIENT_SECRET'), 'redirect' => env('HARID_REDIRECT_URI'), 'use_test_idp' => false, ],
请注意,use_test_idp
可以省略,默认为 false
。
添加提供程序事件监听器
Laravel 11+
在 Laravel 11 中,默认的 EventServiceProvider
提供程序已被移除。取而代之的是,在 AppServiceProvider
的 boot
方法中使用 Event
门面的 listen
方法添加监听器。
- 注意:除非您使用自己的提供程序覆盖它们,否则不需要为内置的 Socialite 提供程序添加任何内容。
Event::listen(function (\SocialiteProviders\Manager\SocialiteWasCalled $event) { $event->extendSocialite('harid', \SocialiteProviders\HarID\Provider::class); });
Laravel 10 或以下
配置包的监听器以监听 `SocialiteWasCalled` 事件。将事件添加到 app/Providers/EventServiceProvider
中的 listen[]
数组中。有关详细说明,请参阅基本安装指南。
protected $listen = [ \SocialiteProviders\Manager\SocialiteWasCalled::class => [ // ... other providers \SocialiteProviders\HarID\HarIDExtendSocialite::class.'@handle', ], ];
使用方法
现在您应该能够像通常使用 Socialite 一样使用该提供程序(假设您已安装门面)
return Socialite::driver('harid')->redirect();
默认作用域设置为 openid profile email session_type
。还可以设置其他作用域,如 personal_code
、roles
和 custodies
。有关详细信息,请参阅 HarID 文档。如果您真的想添加一些附加作用域或替换默认作用域,请阅读 文档。
返回的用户字段
id
nickname
- 将具有sub
的值,可能应该是保密的name
email
avatar
- 将设置为空字符串,因为HarID
不提供任何图像
其他 HarID 特定数据
given_name
family_name
email_verified
strong_session
ui_locales
这些存储在 user
参数中,可以使用 offsetExists($name)
检查,使用 offsetGet($name)
获取。