class SystemBrandingOffCanvasForm extends PluginFormBase implements ContainerInjectionInterface (View source)

internal  
 

The settings_tray form handler for the SystemBrandingBlock.

Properties

protected BlockPluginInterface $plugin

The block plugin.

protected ConfigFactoryInterface $configFactory

The config factory.

protected AccountInterface $currentUser

The current user.

Methods

setPlugin(PluginInspectionInterface $plugin)

Sets the plugin for this object.

validateConfigurationForm(array $form, FormStateInterface $form_state)

Form validation handler.

__construct(ConfigFactoryInterface $config_factory, AccountInterface $current_user)

SystemBrandingOffCanvasForm constructor.

static 
create(ContainerInterface $container)

Instantiates a new instance of this class.

array
buildConfigurationForm(array $form, FormStateInterface $form_state)

Form constructor.

submitConfigurationForm(array $form, FormStateInterface $form_state)

Form submission handler.

Details

setPlugin(PluginInspectionInterface $plugin)

Sets the plugin for this object.

Parameters

PluginInspectionInterface $plugin

The plugin.

validateConfigurationForm(array $form, FormStateInterface $form_state)

Form validation handler.

Parameters

array $form

An associative array containing the structure of the plugin form as built by static::buildConfigurationForm().

FormStateInterface $form_state

The current state of the form. Calling code should pass on a subform state created through \Drupal\Core\Form\SubformState::createForSubform().

__construct(ConfigFactoryInterface $config_factory, AccountInterface $current_user)

SystemBrandingOffCanvasForm constructor.

Parameters

ConfigFactoryInterface $config_factory

The config factory.

AccountInterface $current_user

The current user.

static create(ContainerInterface $container)

Instantiates a new instance of this class.

This is a factory method that returns a new instance of this class. The factory should pass any needed dependencies into the constructor of this class, but not the container itself. Every call to this method must return a new instance of this class; that is, it may not implement a singleton.

Parameters

ContainerInterface $container

The service container this instance should use.

array buildConfigurationForm(array $form, FormStateInterface $form_state)

Form constructor.

Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and

array_parents, see \Drupal\Core\Render\Element\FormElement.

Parameters

array $form

An associative array containing the initial structure of the plugin form.

FormStateInterface $form_state

The current state of the form. Calling code should pass on a subform state created through \Drupal\Core\Form\SubformState::createForSubform().

Return Value

array

The form structure.

submitConfigurationForm(array $form, FormStateInterface $form_state)

Form submission handler.

Parameters

array $form

An associative array containing the structure of the plugin form as built by static::buildConfigurationForm().

FormStateInterface $form_state

The current state of the form. Calling code should pass on a subform state created through \Drupal\Core\Form\SubformState::createForSubform().