socialiteproviders/whmcs

WHMCS OAuth2 Provider for Laravel Socialite

4.1.0 2020-12-01 23:10 UTC

Requires

• php: ^7.2 || ^8.0
• ext-json: *
• socialiteproviders/manager: ~4.0

MIT

• Adnan RIHAN

README

composer require socialiteproviders/whmcs

Installation & Basic Usage

Please see the Base Installation Guide, then follow the provider specific instructions below.

Specific configuration

Follow this link to create OpenID credentials in your WHMCS installation

Add configuration to 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
],

Add provider event listener

Laravel 11+

In Laravel 11, the default EventServiceProvider provider was removed. Instead, add the listener using the listen method on the Event facade, in your AppServiceProvider boot method.

• Note: You do not need to add anything for the built-in socialite providers unless you override them with your own providers.

Event::listen(function (\SocialiteProviders\Manager\SocialiteWasCalled $event) {
    $event->extendSocialite('whmcs', \SocialiteProviders\Whmcs\Provider::class);
});

Laravel 10 or below

Configure the package's listener to listen for `SocialiteWasCalled` events.

Add the event to your listen[] array in app/Providers/EventServiceProvider. See the Base Installation Guide for detailed instructions.

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

Usage

You should now be able to use the provider like you would regularly use Socialite (assuming you have the facade installed):

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

Returned User fields

• id
• name
• email

More fields are available under the user subkey:

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

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