class Registration

Properties

protected array $provided
protected array $suggested
protected mixed $payload

Methods

array
getProvided()

No description

array
getSuggested()

No description

mixed
getPayload()

No description

provide(string $key, mixed $value)

No description

provideTrustedEmail(string $email)

Provide an email address the provider has verified belongs to the user.

provideAvatar(string $url)

No description

provideAvatar2x(string $url)

Provide a 2× (200px) HiDPI avatar URL from the OAuth provider.

provideAvatar3x(string $url)

Provide a 3× (300px) HiDPI avatar URL from the OAuth provider.

suggest(string $key, mixed $value)

No description

suggestUsername(string $username)

No description

suggestEmail(string $email)

No description

setPayload(mixed $payload)

No description

Details

array getProvided()

Return Value

array

array getSuggested()

Return Value

array

mixed getPayload()

Return Value

mixed

Registration provide(string $key, mixed $value)

Parameters

string $key
mixed $value

Return Value

Registration

Registration provideTrustedEmail(string $email)

Provide an email address the provider has verified belongs to the user.

An account registered with it starts activated, and the provider may be linked to an existing account that uses it ({[\Flarum\Forum\Auth\ResponseFactory::findUserToLink()}). Use](../../../Flarum/Forum/Auth/ResponseFactory.html) {\Flarum\Forum\Auth\suggestEmail()} for an address the provider hasn't verified.

Parameters

string $email

Return Value

Registration

Registration provideAvatar(string $url)

Parameters

string $url

Return Value

Registration

Registration provideAvatar2x(string $url)

Provide a 2× (200px) HiDPI avatar URL from the OAuth provider.

Call this alongside provideAvatar() when the provider's CDN supports sized images (e.g. GitHub's ?s=200). Flarum will fetch and store this URL directly rather than upscaling the base avatar.

Parameters

string $url

Return Value

Registration

Registration provideAvatar3x(string $url)

Provide a 3× (300px) HiDPI avatar URL from the OAuth provider.

Call this alongside provideAvatar() when the provider's CDN supports sized images (e.g. GitHub's ?s=300). Flarum will fetch and store this URL directly rather than upscaling the base avatar.

Parameters

string $url

Return Value

Registration

Registration suggest(string $key, mixed $value)

Parameters

string $key
mixed $value

Return Value

Registration

Registration suggestUsername(string $username)

Parameters

string $username

Return Value

Registration

Registration suggestEmail(string $email)

Parameters

string $email

Return Value

Registration

Registration setPayload(mixed $payload)

Parameters

mixed $payload

Return Value

Registration