LoginProviderFormTrait
Add/edit form of a login provider (OAuth).
The skeleton comes from BasePresenter::createForm(), the multilingual fields and conversions from AdminFormHelpersTrait.
Translated: name, buttonText. Untranslated: key, clientId, clientSecret, scope,
buttonHtmlClass, iconHtmlClass, active (the header toggle).
Table of Contents
Methods
- createComponentEditForm() : Form
- addSettingsFields() : void
- OAuth settings and button look.
- addTranslationFields() : void
- Per-language fields: name and button text, required only when the language is active.
- buildLoginProviderEntity() : LoginProvider
- saveLoginProviderForm() : bool
- Saves the form data; the redirect is handled by {@see \App\Core\Base\Admin\BasePresenter::createForm()}.
- setLoginProviderFormDefaults() : void
Methods
createComponentEditForm()
protected
createComponentEditForm() : Form
Return values
FormaddSettingsFields()
OAuth settings and button look.
private
addSettingsFields(Form $form) : void
Parameters
- $form : Form
addTranslationFields()
Per-language fields: name and button text, required only when the language is active.
private
addTranslationFields(Form $form) : void
Parameters
- $form : Form
buildLoginProviderEntity()
private
buildLoginProviderEntity(ArrayHash<string|int, mixed> $values) : LoginProvider
Parameters
- $values : ArrayHash<string|int, mixed>
Return values
LoginProvidersaveLoginProviderForm()
Saves the form data; the redirect is handled by {@see \App\Core\Base\Admin\BasePresenter::createForm()}.
private
saveLoginProviderForm(ArrayHash<string|int, mixed> $values) : bool
Parameters
- $values : ArrayHash<string|int, mixed>
Return values
boolsetLoginProviderFormDefaults()
private
setLoginProviderFormDefaults(Form $form) : void
Parameters
- $form : Form