Skip to content
docsv0.1.0

GitHubOAuthServiceInterface

Contract for GitHub OAuth operations. Each consumer plugin provides its own redirectUri to support independent callback routes per plugin.

GitHubOAuthServiceInterface::getAuthUrl()

abstract public function getAuthUrl(string $redirectUri, ?string $state = null): string

Build the GitHub authorization URL.

Parameters

Parameters of getAuthUrl()
NameTypeDescription
$redirectUristringCallback URL specific to the consumer plugin
$state(string | null)Opaque CSRF-protection value. When given, it is appended to the URL as-is and GitHub echoes it back unmodified on the query string of the callback request. Generating, storing, and verifying it is entirely the caller's responsibility — this provider only transports it.

GitHubOAuthServiceInterface::exchangeCode()

abstract public function exchangeCode(string $code, string $redirectUri): Milpa\OAuth\DTO\GitHubUserInfo

Exchange authorization code for user info.

Parameters

Parameters of exchangeCode()
NameTypeDescription
$codestringAuthorization code from GitHub callback
$redirectUristringMust match the one used in getAuthUrl()