socialiteproviders / bexio
Bexio OAuth2 Provider for Laravel Socialite
Requires
- php: ^7.2 || ^8.0
- ext-json: *
- socialiteproviders/manager: ^4.0
This package is auto-updated.
Last update: 2024-11-07 22:00:12 UTC
README
composer require socialiteproviders/bexio
Installation & Basic Usage
Please see the Base Installation Guide, then follow the provider specific instructions below.
Add configuration to config/services.php
'bexio' => [ 'client_id' => env('BEXIO_CLIENT_ID'), 'client_secret' => env('BEXIO_CLIENT_SECRET'), 'redirect' => env('BEXIO_REDIRECT_URI') ],
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('bexio', \SocialiteProviders\Bexio\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\Bexio\BexioExtendSocialite::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('bexio')->redirect();
Getting a user on callback URL
$externalUserData = Socialite::driver($driver)->user();
The $externalUserData variable will have a \SocialiteProviders\Manager\OAuth2\User instance with the following provider specific data:
$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