lonesta/socialite-zerion

Zerion OAuth2 Provider for Laravel Socialite

v14 2017-12-21 13:52 UTC

This package is not auto-updated.

Last update: 2024-03-24 12:22:02 UTC


README

1. Installation

composer require lonesta/socialite-zerion

2. Service Provider

  • Remove Laravel\Socialite\SocialiteServiceProvider from your providers[] array in config\app.php if you have added it already.
  • Add SocialiteProviders\Manager\ServiceProvider to your providers[] array in config\app.php.

For example:

'providers' => [
    // a whole bunch of providers
    // remove 'Laravel\Socialite\SocialiteServiceProvider',
    SocialiteProviders\Manager\ServiceProvider::class, // add
];
  • Note: If you would like to use the Socialite Facade, you need to install it.

3. Add the Event and Listeners

  • Add SocialiteProviders\Manager\SocialiteWasCalled::class event to your listen[] array in <app_name>/Providers/EventServiceProvider.

  • Add your listeners (i.e. the ones from the providers) to the SocialiteProviders\Manager\SocialiteWasCalled[] that you just created.

  • The listener that you add for this provider is lonesta\SocialiteProviders\Zerion\ZerionExtendSocialite@handle.

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

For example:

/**
 * The event handler mappings for the application.
 *
 * @var array
 */
protected $listen = [
    \SocialiteProviders\Manager\SocialiteWasCalled::class => [
        'lonesta\SocialiteProviders\Zerion\ZerionExtendSocialite@handle'
    ],
];

4. Services Array and .env

Add to config/services.php:

'zerion' => [
    'client_id'     => env('ZERION_ID'),
    'client_secret' => env('ZERION_SECRET'),
    'redirect'      => env('ZERION_REDIRECT'),
],

Append provider values to your .env file: Note: Add both public and secret keys!

// other values above
ZERION_ID=your_app_id_for_the_service
ZERION_SECRET=your_app_secret_for_the_service
ZERION_REDIRECT=https://example.com/login