fathershawn/oauth2-formassembly

FormAssembly OAuth 2.0 Client Provider for The PHP League OAuth2-Client

1.2 2022-12-12 12:44 UTC

Requires

• php: ^8.1
• league/oauth2-client: ^2.6.1

Requires (Dev)

• mockery/mockery: ^1.5
• phpstan/phpstan-deprecation-rules: ^1.0
• phpunit/phpunit: ^9.5
• squizlabs/php_codesniffer: ^3.6

GPL-2.0-or-later

• Shawn P. Duncan

• authorization
• Authentication
• client
• oauth
• oauth2
• formassembly

README

This package provides FormAssembly OAuth 2.0 support for the PHP League's OAuth 2.0 Client.

Installation

To install, use composer:

composer require fathershawn/oauth2-formassembly

Usage

Request an authorization code

If you are working with FormAssembly, you may have another class by that name, so you can rename the provider:

<?php
use Fathershawn\OAuth2\Client\Provider\FormAssembly as OauthProvider;

$provider = new OauthProvider([
      'clientId' => 'your-client-id',
      'clientSecret' => 'your-client-secret',
      'redirectUri' => 'url-to-capture-the-code',
      'baseUrl' => 'url-to-formassembly-instance',
]);
$url = $provider->getAuthorizationUrl();
// Redirect the user to $url.

When the user is redirected to the url to capture the code:

<?php

use Fathershawn\OAuth2\Client\Provider\FormAssembly as OauthProvider;
// Capture the code with your framework or from $_GET['code'].
$code = $_GET['code'];
$provider = new OauthProvider([
      'clientId' => 'your-client-id',
      'clientSecret' => 'your-client-secret',
      'redirectUri' => 'url-to-capture-the-code',
      'baseUrl' => 'url-to-formassembly-instance',
]);
try {
    $accessToken = $provider->getAccessToken('authorization_code', [
        'code' => $code,
    ]);
    // Store $accessToken as appropriate for re-use.
} catch (Exception $e) {
    // Log the Exception?
    throw $e;
}