Documentation

Maho_SocialLogin_Model_Provider_ProviderInterface
in

Table of Contents

Methods

getCode()  : string
isEnabled()  : bool
requiresNonce()  : bool
Whether the storefront flow must bind this provider's credential to a session-issued nonce (ID-token providers echo it; access-token providers carry no nonce claim).
verify()  : array{sub: string, email: string, given_name: ?string, family_name: ?string, name: ?string}
Verifies a provider credential and returns normalized claims.

Methods

isEnabled()

public isEnabled(int $storeId) : bool
Parameters
$storeId : int
Return values
bool

requiresNonce()

Whether the storefront flow must bind this provider's credential to a session-issued nonce (ID-token providers echo it; access-token providers carry no nonce claim).

public requiresNonce() : bool
Return values
bool

verify()

Verifies a provider credential and returns normalized claims.

public verify(string $token, int $storeId[, string|null $expectedNonce = null ]) : array{sub: string, email: string, given_name: ?string, family_name: ?string, name: ?string}

The returned email is lowercased and guaranteed provider-verified; implementations must reject tokens whose email is missing or unverified.

Parameters
$token : string
$storeId : int
$expectedNonce : string|null = null
Tags
throws
InvalidArgumentException

When the credential is invalid or fails a claim check

RuntimeException

When the provider cannot be reached

Return values
array{sub: string, email: string, given_name: ?string, family_name: ?string, name: ?string}
On this page

Search results