Clerk OAuth2 提供程序,用于 Laravel Socialite

5.0.0 2024-02-19 12:17 UTC

This package is auto-updated.

Last update: 2024-08-31 00:42:51 UTC


README

这是 Clerk 的提供程序

composer require socialiteproviders/clerk

安装与基本用法

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

config/services.php 中添加配置

'clerk' => [
  'client_id' => env('CLERK_CLIENT_ID'),
  'client_secret' => env('CLERK_CLIENT_SECRET'),
  'redirect' => env('CLERK_CALLBACK_URL'),
  'base_url' => env('CLERK_BASE_URL'),
],

.env 中添加基本 URL

Clerk 为您的不同项目提供客户 URL。因此,您需要提供一个 base_url

CLERK_BASE_URL=https://example.clerk.accounts.dev

添加提供程序事件监听器

Laravel 11+

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

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

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

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

用法

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

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

返回的用户字段

  • id
  • 昵称
  • 名字
  • 电子邮件
  • 头像