Documentation

lgmsmoduleSettingsForm extends ConfigFormBase
in package

Configuration form for LGMS module settings.

Provides a form interface for administrators to specify the proxy link prefix applied to certain guide database items. Additionally, it updates existing database item links with the new prefix and adjusts the field description accordingly to reflect the change.

Table of Contents

Methods

buildForm()  : array<string|int, mixed>
Builds the settings form for proxy link prefix configuration.
getFormId()  : string
Gets the unique form ID for the settings form.
submitForm()  : void
Submits the settings form.
getEditableConfigNames()  : array<string|int, mixed>
Returns a list of configuration names that should be editable.

Methods

buildForm()

Builds the settings form for proxy link prefix configuration.

public buildForm(array<string|int, mixed> $form, FormStateInterface $form_state) : array<string|int, mixed>
Parameters
$form : array<string|int, mixed>

The initial form array.

$form_state : FormStateInterface

The state of the form.

Return values
array<string|int, mixed>

The form array with fields for setting the proxy link prefix.

getFormId()

Gets the unique form ID for the settings form.

public getFormId() : string
Return values
string

The form ID.

submitForm()

Submits the settings form.

public submitForm(array<string|int, mixed> &$form, FormStateInterface $form_state) : void

Upon form submission, updates the stored proxy link prefix in configuration, adjusts all existing guide database items to use the new prefix, and updates the field description to reflect the change.

Parameters
$form : array<string|int, mixed>

The form array.

$form_state : FormStateInterface

The state of the form.

Tags
throws
EntityStorageException

getEditableConfigNames()

Returns a list of configuration names that should be editable.

protected getEditableConfigNames() : array<string|int, mixed>
Return values
array<string|int, mixed>

An array of configuration object names that are editable.


        
On this page

Search results