Skip to content

vatsimnetwork/oauth2-vatsim-php

Repository files navigation

VATSIM Connect Provider for OAuth 2.0 Client

Build Status License Latest Stable Version

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

Requirements

To use this package, it will be necessary to have a VATSIM Connect client ID and client secret.

Please follow the VATSIM Connect instructions to create the required credentials.

Installation

To install, use composer:

composer require vatsim/oauth2-vatsim

Usage

Usage is the same as The League's OAuth client, using \Vatsim\OAuth2\Client\Provider\Vatsim as the provider.

Available Options

The Vatsim provider has the following options:

  • domain allows for switching between the prod or dev Connect instance (default: https://auth.vatsim.net)

Scopes

At time of writing, available scopes are:

  • full_name - Full name (first and last)
  • email- Email address
  • country - Residence country
  • vatsim_details - VATSIM pilot rating, ATC rating, region, division, sub-division

Testing

Tests can be run with:

composer test

Style checks can be run with:

composer lint

Contributing

Please see CONTRIBUTING.md for details.

Credits

License

The MIT License (MIT). Please see the License File for more information.

About

VATSIM Connect OAuth 2.0 support for The PHP League's OAuth 2.0 Client

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages