IDeclarativeSettingsFormWithHandlers
extends
IDeclarativeSettingsForm
in
Tags
Table of Contents
Methods
- getSchema() : DeclarativeSettingsFormSchemaWithoutValues
- Gets the schema that defines the declarative settings form
- getValue() : mixed
- This function is called to get the current value of a specific forms field.
- setValue() : void
- This function is called when a user updated a form field to persist the setting.
Methods
getSchema()
Gets the schema that defines the declarative settings form
public
getSchema() : DeclarativeSettingsFormSchemaWithoutValues
Tags
Return values
DeclarativeSettingsFormSchemaWithoutValuesgetValue()
This function is called to get the current value of a specific forms field.
public
getValue(string $fieldId, IUser $user) : mixed
Parameters
- $fieldId : string
- $user : IUser
Tags
setValue()
This function is called when a user updated a form field to persist the setting.
public
setValue(string $fieldId, mixed $value, IUser $user) : void
Parameters
- $fieldId : string
- $value : mixed
- $user : IUser