Documentation

Application

Table of Contents

Interfaces

ClientCredentials: Indicates whether the provider is capable of the OAuth2 client credentials authentication flow.
CSRFToken: Specifies the methods required for the OAuth2 CSRF token validation ("state parameter")
OAuth1Interface: Specifies the basic methods for an OAuth1 provider.
OAuth2Interface: Specifies the basic methods for an OAuth2 provider.
OAuthInterface: Specifies the basic methods for an OAuth provider.
PAR: Specifies the methods required for the OAuth2 Pushed Authorization Requests (PAR)
PKCE: Specifies the methods required for the OAuth2 Proof Key for Code Exchange (PKCE)
TokenInvalidate: Indicates whether the provider is capable of invalidating access tokens (RFC-7009 or proprietary)
TokenRefresh: Indicates whether the provider is capable of the OAuth2 token refresh.
UserInfo: Indicates whether the service can provide information about the currently authenticated user, usually via a "/me", "/user" or "/tokeninfo" endpoint.
OAuthStorageInterface: Specifies the methods required for an OAuth storage adapter

Classes

AccessToken: Access token implementation for any OAuth version.
AuthenticatedUser: A simple read-only container for user data responses
CSRFStateMismatchException: Thrown on mismatching CSRF ("state") token
InvalidAccessTokenException: Thrown when an access token is expired and cannot be refreshed
OAuth1Provider: Implements an abstract OAuth1 (1.0a) provider with all methods required by the OAuth1Interface.
OAuth2Provider: Implements an abstract OAuth2 provider with all methods required by the OAuth2Interface.
OAuthProvider: Implements an abstract OAuth provider with all methods required by the OAuthInterface.
UnauthorizedAccessException: Thrown on generic "Unauthorized" HTTP errors: 400, 401, 403
Utilities: Common utilities for use with the OAuth providers
OAuthException: Generic exception container
OAuthOptions: This class holds all settings related to the OAuth provider
OAuthProviderFactory: A simple OAuth provider factory (not sure if that clears the mess...)
Amazon: Login with Amazon for Websites (OAuth2)
AzureActiveDirectory: Microsoft identity platform (OAuth2)
BattleNet: Battle.net OAuth2
BigCartel: BigCartel OAuth2
Bitbucket: Bitbucket OAuth2 (Atlassian)
Codeberg: Codeberg OAuth2
Deezer: Deezer OAuth2
DeviantArt: DeviantArt OAuth2
Discogs: Discogs OAuth1
Discord: Discord OAuth2
Flickr: Flickr OAuth1
Foursquare: Foursquare OAuth2
Gitea: Gitea OAuth2
GitHub: GitHub OAuth2
GitLab: GitLab OAuth2
Google: Google OAuth2
GuildWars2: Guild Wars 2
Imgur: Imgur OAuth2
LastFM: Last.fm
MailChimp: MailChimp OAuth2
Mastodon: Mastodon OAuth2 (v4.x instances)
MicrosoftGraph: Microsoft Graph OAuth2
Mixcloud: Mixcloud OAuth2
MusicBrainz: MusicBrainz OAuth2
NPROne: NPR API services (OAuth2)
OpenCaching: Opencaching OAuth1
OpenStreetmap: OpenStreetmap OAuth1 (deprecated)
OpenStreetmap2: OpenStreetmap OAuth2
Patreon: Patreon v2 OAuth2
PayPal: PayPal OAuth2
PayPalSandbox: PayPal OAuth2 (sandbox)
Pinterest: Pinterest OAuth2
ProviderException: Generic exception container
Reddit: Reddit OAuth2
Slack: Slack v2 OAuth2
SoundCloud: SoundCloud OAuth2
Spotify: Spotify OAuth2
Steam: Steam OpenID
Stripe: Stripe OAuth2
Tumblr: Tumblr OAuth1
Tumblr2: Tumblr OAuth2
Twitch: Twitch OAuth2
Twitter: Twitter OAuth1
TwitterCC: Twitter OAuth2 (client credentials)
Vimeo: Vimeo OAuth2
WordPress: WordPress OAuth2
YouTube: YouTube OAuth2
FileStorage: Implements a filesystem storage adapter.
ItemNotFoundException: Thrown when an item cannot be found in the storage
MemoryStorage: Implements a memory storage adapter.
OAuthStorageAbstract: Implements an abstract OAuth storage adapter
OAuthStorageException: Thrown on general storage errors
SessionStorage: Implements a session storage adapter.
Provider: Supplies the provider class name
AccessTokenTest: Tests the AccessToken class
AuthenticatedUserTest: Tests the AuthenticatedUser class
OAuthOptionsTest: Tests the OAuthOptions class
OAuthProviderFactoryTest: Tests the OAuthProviderFactory class
UtilitiesTest: Tests the Utilities class
DummyOAuth1Provider: An OAuth1 provider implementation
DummyOAuth2Provider: An OAuth2 provider implementation that supports token refresh, csrf tokens and client credentials
AmazonAPITest: OAuth2 live API test
BattleNetAPITest: OAuth2 live API test
BigCartelAPITest: OAuth2 live API test
BitbucketAPITest: OAuth2 live API test
CodebergAPITest: OAuth2 live API test
DeezerAPITest: OAuth2 live API test
DeviantArtAPITest: OAuth2 live API test
DiscogsAPITest: OAuth1 live API test
DiscordAPITest: OAuth2 live API test
FlickrAPITest: OAuth1 live API test
FoursquareAPITest: OAuth2 live API test
GiteaAPITest: OAuth2 live API test
GitHubAPITest: OAuth2 live API test
GitLabAPITest: OAuth2 live API test
GoogleAPITest: OAuth2 live API test
GuildWars2APITest: OAuth2 live API test
ImgurAPITest: OAuth2 live API test
LastFMAPITest: abstract OAuth live API test
MailChimpAPITest: OAuth2 live API test
MastodonAPITest: OAuth2 live API test
MicrosoftGraphAPITest: OAuth2 live API test
MixcloudAPITest: OAuth2 live API test
MusicBrainzAPITest: OAuth2 live API test
NPROneAPITest: OAuth2 live API test
OAuth1ProviderLiveTestAbstract: OAuth1 live API test
OAuth2ProviderLiveTestAbstract: OAuth2 live API test
OAuthProviderLiveTestAbstract: abstract OAuth live API test
OpenCachingAPITest: OAuth1 live API test
OpenStreetmap2APITest: OAuth2 live API test
OpenStreetmapAPITest: OAuth1 live API test
PatreonAPITest: OAuth2 live API test
PayPalAPITest: OAuth2 live API test
PinterestAPITest: OAuth2 live API test
RedditAPITest: OAuth2 live API test
SlackAPITest: OAuth2 live API test
SoundcloudAPITest: OAuth2 live API test
SpotifyAPITest: OAuth2 live API test
SteamAPITest: abstract OAuth live API test
StripeAPITest: OAuth2 live API test
Tumblr2APITest: OAuth2 live API test
TumblrAPITest: OAuth1 live API test
TwitchAPITest: OAuth2 live API test
TwitterAPITest: OAuth1 live API test
TwitterCCAPITest: OAuth2 live API test
VimeoAPITest: OAuth2 live API test
WordpressAPITest: OAuth2 live API test
YouTubeAPITest: OAuth2 live API test
ProviderLiveTestAbstract: The abstract base class for all live API tests
ProviderLiveTestHttpClientFactory: A PSR-18 HTTP client factory for clients used in live API tests
ProviderTestLoggerFactory: A simple PSR-3 logger factory used in provider tests
ProviderUnitTestAbstract: The abstract base class for all provider tests
ProviderUnitTestHttpClientFactory: A PSR-18 HTTP client factory for provider unit tests
AmazonTest: OAuth2 unit test
BattleNetTest: OAuth2 unit test
BigCartelTest: OAuth2 unit test
BitbucketTest: OAuth2 unit test
CodebergTest: OAuth2 unit test
DeezerTest: OAuth2 unit test
DeviantArtTest: OAuth2 unit test
DiscogsTest: OAuth1 unit test
DiscordTest: OAuth2 unit test
FlickrTest: OAuth1 unit test
FoursquareTest: OAuth2 unit test
GiteaTest: OAuth2 unit test
GitHubTest: OAuth2 unit test
GitLabTest: OAuth2 unit test
GoogleTest: OAuth2 unit test
GuildWars2Test: OAuth2 unit test
ImgurTest: OAuth2 unit test
LastFMTest: abstract OAuth unit test
MailChimpTest: OAuth2 unit test
MastodonTest: OAuth2 unit test
MicrosoftGraphTest: OAuth2 unit test
MixcloudTest: OAuth2 unit test
MusicBrainzTest: OAuth2 unit test
NPROneTest: OAuth2 unit test
OAuth1ProviderUnitTestAbstract: OAuth1 unit test
OAuth1Test: The built-in dummy test for OAuth1
OAuth2ProviderUnitTestAbstract: OAuth2 unit test
OAuth2Test: The built-in dummy test for OAuth2
OAuthProviderUnitTestAbstract: abstract OAuth unit test
OpenCachingTest: OAuth1 unit test
OpenStreetmap2Test: OAuth2 unit test
OpenStreetmapTest: OAuth1 unit test
PatreonTest: OAuth2 unit test
PayPalTest: OAuth2 unit test
PinterestTest: OAuth2 unit test
RedditTest: OAuth2 unit test
SlackTest: OAuth2 unit test
SoundCloudTest: OAuth2 unit test
SpotifyTest: OAuth2 unit test
SteamTest: abstract OAuth unit test
StripeTest: OAuth2 unit test
Tumblr2Test: OAuth2 unit test
TumblrTest: OAuth1 unit test
TwitchTest: OAuth2 unit test
TwitterCCTest: OAuth2 unit test
TwitterTest: OAuth1 unit test
VimeoTest: OAuth2 unit test
WordPressTest: OAuth2 unit test
YouTubeTest: OAuth2 unit test
FileStorageEncryptedTest: Tests the `FileStorage` class (encrypted)
FileStorageTest: Tests the `FileStorage` class
MemoryStorageTest: Tests the `MemoryStorage` class
SessionStorageEncryptedTest: Tests the `SessionStorage` class (encrypted)
SessionStorageTest: Tests the `SessionStorage` class
StorageTestAbstract: The abstract storage test

Traits

ClientCredentialsTrait: Implements Client Credentials functionality
PARTrait: Implements PAR (Pushed Authorization Requests) functionality
PKCETrait: Implements PKCE (Proof Key for Code Exchange) functionality
TokenInvalidateTrait: Implements token invalidation functionality
OAuthOptionsTrait: The settings for the OAuth provider

On this page

Table Of Contents