jbelien / oauth2-openstreetmap
OpenStreetMap OAuth 2.0 support for the PHP League's OAuth 2.0 Client
Installs: 7 690
Dependents: 1
Suggesters: 0
Security: 0
Stars: 3
Watchers: 0
Forks: 2
Open Issues: 5
Requires
- league/oauth2-client: ^2.6
Requires (Dev)
- mockery/mockery: ^1.4
- phpunit/phpunit: ^9.5
- squizlabs/php_codesniffer: ^3.6
This package is auto-updated.
Last update: 2024-10-30 02:40:59 UTC
README
This package provides OpenStreetMap OAuth 2.0 support for the PHP League's OAuth 2.0 Client.
Installation
composer require jbelien/oauth2-OpenStreetMap
Usage
$OpenStreetMapProvider = new \JBelien\OAuth2\Client\Provider\OpenStreetMap([ 'clientId' => 'yourId', // The client ID assigned to you by OpenStreetMap.org 'clientSecret' => 'yourSecret', // The client password assigned to you by OpenStreetMap.org 'redirectUri' => 'yourRedirectUri', // The return URL you specified for your app on OpenStreetMap.org 'dev' => false // Whether to use the OpenStreetMap test environment at https://master.apis.dev.openstreetmap.org/ ]); // Get authorization code if (!isset($_GET['code'])) { // Options are optional, defaults to 'read_prefs' only $options = ['scope' => 'read_prefs read_gpx']; // Get authorization URL $authorizationUrl = $OpenStreetMapProvider->getAuthorizationUrl($options); // Get state and store it to the session $_SESSION['oauth2state'] = $OpenStreetMapProvider->getState(); // Redirect user to authorization URL header('Location: ' . $authorizationUrl); exit; // Check for errors } elseif (empty($_GET['state']) || (isset($_SESSION['oauth2state']) && $_GET['state'] !== $_SESSION['oauth2state'])) { if (isset($_SESSION['oauth2state'])) { unset($_SESSION['oauth2state']); } exit('Invalid state'); } else { // Get access token try { $accessToken = $OpenStreetMapProvider->getAccessToken( 'authorization_code', [ 'code' => $_GET['code'] ] ); } catch (\League\OAuth2\Client\Provider\Exception\IdentityProviderException $e) { exit($e->getMessage()); } // Get resource owner try { $resourceOwner = $OpenStreetMapProvider->getResourceOwner($accessToken); } catch (\League\OAuth2\Client\Provider\Exception\IdentityProviderException $e) { exit($e->getMessage()); } // Now you can store the results to session etc. $_SESSION['accessToken'] = $accessToken; $_SESSION['resourceOwner'] = $resourceOwner; var_dump( $resourceOwner->getId(), $resourceOwner->getDisplayName(), $resourceOwner->getAccountCreated(), $resourceOwner->getImage(), $resourceOwner->getChangesetsCount(), $resourceOwner->getLanguages(), $resourceOwner->toArray() ); }
For more information see the PHP League's general usage examples.
Testing
./vendor/bin/phpunit
License
The MIT License (MIT). Please see License File for more information.