vatsim / oauth2-vatsim
VATSIM OAuth 2.0 Client Provider for The PHP League OAuth2-Client
Requires
- php: ^7.4 || ^8.0
- league/oauth2-client: ^2.0
Requires (Dev)
- ext-json: *
- mockery/mockery: ^1.4
- phpunit/phpunit: ^9.3
- squizlabs/php_codesniffer: ^3.5
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
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:
domainallows 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 addresscountry- Residence countryvatsim_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.