You are here

Home » API reference » Layout Builder Browser 8 » SettingsForm.php

class SettingsForm in Layout Builder Browser 8

Settings form.

Hierarchy

Expanded class hierarchy of SettingsForm

1 string reference to 'SettingsForm'
layout_builder_browser.routing.yml in ./layout_builder_browser.routing.yml
layout_builder_browser.routing.yml

File

src/Form/SettingsForm.php, line 12

Namespace

Drupal\layout_builder_browser\Form
View source 
class SettingsForm extends ConfigFormBase {

  /**
   * The entity_type.bundle.info service.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $entityTypeBundleInfo;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {

    /**
     * @var \Drupal\metatag\Form\MetatagSettingsForm
     */
    $instance = parent::create($container);
    $instance->entityTypeBundleInfo = $container
      ->get('entity_type.bundle.info');
    return $instance;
  }

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'layout_builder_browser.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $block_id = NULL) {
    $config = $this
      ->config('layout_builder_browser.settings');
    $options = [
      'defaults' => 'Defaults<br>The layout builder mainly used by site builders, on the global entity settings.',
      'overrides' => 'Overrides<br>When a user edits a specific entity layout, this will trigger. You need to enable overrides for this on the entity view mode.',
    ];
    $form['enabled_section_storages'] = [
      '#title' => $this
        ->t('Enable layout builder browser on'),
      '#type' => 'checkboxes',
      '#options' => $options,
      '#default_value' => $config
        ->get('enabled_section_storages'),
    ];
    $form['use_modal'] = [
      '#title' => $this
        ->t('Show layout builder browser in modal'),
      '#description' => $this
        ->t('If checked, the layout builder browser will be rendered in a modal instead of using the off-canvas method.'),
      '#type' => 'checkbox',
      '#default_value' => $config
        ->get('use_modal') ?? FALSE,
    ];
    $bundles = $this->entityTypeBundleInfo
      ->getBundleInfo('block_content');
    $bundle_options = [];
    foreach ($bundles as $machine_name => $bundle) {
      $bundle_options[$machine_name] = $bundle['label'];
    }
    $form['auto_added_reusable_block_content_bundles'] = [
      '#title' => $this
        ->t('Automatically add reusable content blocks by bundle'),
      '#description' => $this
        ->t('Reusable block content entities for selected bundles will automatically be visible as a separate category per bundle. Blocks already placed in another layout builder browser category will not be listed again.'),
      '#type' => 'checkboxes',
      '#options' => $bundle_options,
      '#default_value' => $config
        ->get('auto_added_reusable_block_content_bundles') ?? [],
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('layout_builder_browser.settings');
    $config
      ->set('enabled_section_storages', array_filter($form_state
      ->getValue('enabled_section_storages')));
    $config
      ->set('use_modal', $form_state
      ->getValue('use_modal'));
    $config
      ->set('auto_added_reusable_block_content_bundles', array_filter($form_state
      ->getValue('auto_added_reusable_block_content_bundles')));
    $config
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBase::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 11
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
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. 1
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. Overrides UrlGeneratorTrait::redirect
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 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
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. 29
MessengerTrait::messenger public function Gets the messenger. 29
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.
SettingsForm::$entityTypeBundleInfo protected property The entity_type.bundle.info service.
SettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
SettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.