socialiteproviders/flexmls

Flexmls OAuth2 Provider for Laravel Socialite

4.0.0 2021-02-24 22:46 UTC

Requires

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

MIT

• Tim Kramer

README

Laravel Socialite provider for the FlexMLS Spark Platform.

composer require socialiteproviders/flexmls

Installation & Basic Usage

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

Add configuration to config/services.php

'flexmls' => [    
  'client_id' => env('SPARKPLATFORM_CLIENT_ID'),  
  'client_secret' => env('SPARKPLATFORM_CLIENT_SECRET'),  
  'redirect' => env('SPARKPLATFORM_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('flexmls', \SocialiteProviders\Flexmls\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\Flexmls\FlexmlsExtendSocialite::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('flexmls')->redirect();

Note that ALL requests made to the Spark API are required to have an X-SparkApi-User-Agent header present, or the request will fail with a 400 error.

Returned User fields

• id
• name
• email

The provider will also return the entire user profile document as a user array within the SocialiteProviders\Manager\OAuth2\User object.

License

MIT