class GlobalSettingsForm in Layout Builder Component Attributes 1.2.x

Global settings form.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
    • class \Drupal\layout_builder_component_attributes\Form\GlobalSettingsForm

1 string reference to 'GlobalSettingsForm'

layout_builder_component_attributes.routing.yml in ./layout_builder_component_attributes.routing.yml

layout_builder_component_attributes.routing.yml

File

src/Form/GlobalSettingsForm.php, line 11

Namespace

Drupal\layout_builder_component_attributes\Form

class GlobalSettingsForm extends ConfigFormBase {

  /**
   * Config settings.
   *
   * @var string
   */
  const SETTINGS = 'layout_builder_component_attributes.settings';

  /**
   * Configuration categories.
   *
   * @var array
   */
  protected $categories = [
    'allowed_block_attributes',
    'allowed_block_title_attributes',
    'allowed_block_content_attributes',
  ];

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'layout_builder_component_attributes_settings';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      static::SETTINGS,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config(static::SETTINGS)
      ->get();

    // Convert the true/false values back into a format FAPI expects.
    // attribute => attribute (for true).
    // attribute => 0 (for false).
    foreach ($config as $category => $cat_config) {
      if (in_array($category, $this->categories)) {
        foreach ($cat_config as $attribute => $value) {
          $config[$category][$attribute] = $value ? $attribute : 0;
        }
      }
    }
    $options = [
      'id' => $this
        ->t('ID'),
      'class' => $this
        ->t('Class(es)'),
      'style' => $this
        ->t('Inline CSS styles'),
      'data' => $this
        ->t('Custom data-* attributes'),
    ];
    $form['intro'] = [
      '#markup' => $this
        ->t('<p>Attributes can be added to 1) the block (outer) element, 2) the block title, and 3) the block content (inner) element. Control which attributes are made available to content editors below:</p>'),
    ];
    $form['allowed_block_attributes'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Allowed block attributes'),
      '#options' => $options,
      '#default_value' => $config['allowed_block_attributes'],
    ];
    $form['allowed_block_title_attributes'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Allowed block title attributes'),
      '#options' => $options,
      '#default_value' => $config['allowed_block_title_attributes'],
    ];
    $form['allowed_block_content_attributes'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Allowed block content attributes'),
      '#options' => $options,
      '#default_value' => $config['allowed_block_content_attributes'],
      '#description' => $this
        ->t('In order for attributes to be rendered on the the block content (inner) element, the active front-end theme must support <code>content_attributes</code> in its block.html.twig file. See README.md for more information.'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this->configFactory
      ->getEditable(static::SETTINGS);

    // Loop through configuration categories.
    foreach ($this->categories as $category) {
      $cat_config = $form_state
        ->getValue($category);

      // Convert the FAPI values into booleans for config storage.
      foreach ($cat_config as $attribute => $value) {
        $cat_config[$attribute] = $value ? TRUE : FALSE;
      }
      $config
        ->set($category, $cat_config);
    }
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create	18
ConfigFormBase::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object.	16
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	3
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::configFactory	protected	function	Gets the config factory for this form.	3
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route.
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	72
GlobalSettingsForm::$categories	protected	property	Configuration categories.
GlobalSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
GlobalSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
GlobalSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
GlobalSettingsForm::SETTINGS		constant	Config settings.
GlobalSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.