WHMCS OAuth2 Provider for Laravel Socialite

4.1.0 2020-12-01 23:10 UTC

This package is auto-updated.

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


README

composer require socialiteproviders/whmcs

安装与基本使用

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

特定配置

访问 此链接 在您的 WHMCS 安装中创建 OpenID 凭证

将配置添加到 config/services.php

'whmcs' => [
    'client_id' => env('WHMCS_CLIENT_ID'),
    'client_secret' => env('WHMCS_CLIENT_SECRET'),
    'redirect' => env('WHMCS_REDIRECT_URI'),
    'url' => env('WHMCS_URL'), // URL of your WHMCS installation
],

添加提供者事件监听器

Laravel 11+

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

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

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

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

使用方法

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

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

返回的用户字段

  • id
  • name
  • email

user 子键下还有更多字段可用

$user = Socialite::driver('whmcs')->user();

$locale = $user->user['locale'];
$email_verified = $user->user['email_verified'];