Bexio OAuth2 提供程序 for Laravel Socialite

5.0.0 2022-02-17 00:03 UTC

This package is auto-updated.

Last update: 2024-08-26 21:27:22 UTC


README

composer require socialiteproviders/bexio

安装 & 基本用法

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

config/services.php 中添加配置

'bexio' => [
  'client_id' => env('BEXIO_CLIENT_ID'),
  'client_secret' => env('BEXIO_CLIENT_SECRET'),
  'redirect' => env('BEXIO_REDIRECT_URI')
],

添加提供程序事件监听器

Laravel 11+

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

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

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

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

用法

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

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

在回调 URL 上获取用户

$externalUserData = Socialite::driver($driver)->user();

$externalUserData 变量将包含一个 \SocialiteProviders\Manager\OAuth2\User 实例,其中包含以下特定提供程序的数据

$externalUserData->id,// null
$externalUserData->email,// User's email
$externalUserData->nickname,// null
$externalUserData->given_name,// First name from bexio profile
$externalUserData->family_name,// Last name from bexio profile
$externalUserData->name,// First and Last names combined
$externalUserData->gender,// Gender from bexio profile
$externalUserData->locale,// en_GB string or other locale definition