Exment OAuth2 Provider for Laravel Socialite

5.0.0 2022-02-16 23:55 UTC

This package is auto-updated.

Last update: 2024-06-02 00:08:45 UTC


README

composer require socialiteproviders/exment

What is Exment?

Exment is open source software for managing information assets on the Web.
For Web Database, SFA, CRM, Business improvement, ...
GitHub
Manual
How to config API
API Reference

Installation & Basic Usage

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

Add configuration to config/services.php

'exment' => [    
  'client_id' => env('EXMENT_CLIENT_ID'),  
  'client_secret' => env('EXMENT_CLIENT_SECRET'),  
  'redirect' => env('EXMENT_REDIRECT_URI'),
  'exment_uri' => env('EXMENT_URI'), // NEED THIS ENV. This is endpoint to access Exment.
],

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('exment', \SocialiteProviders\Exment\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\Exment\ExmentExtendSocialite::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('exment')->redirect();

Returned User fields

  • id
  • nickname
  • name
  • email