class LayoutForm

Same name and namespace in other branches
  1. 10 core/modules/navigation/src/Form/LayoutForm.php \Drupal\navigation\Form\LayoutForm

Defines a form for configuring navigation blocks.

@internal

Hierarchy

Expanded class hierarchy of LayoutForm

1 file declares its use of LayoutForm
NavigationSectionStorage.php in core/modules/navigation/src/Plugin/SectionStorage/NavigationSectionStorage.php

File

core/modules/navigation/src/Form/LayoutForm.php, line 20

Namespace

Drupal\navigation\Form
View source
final class LayoutForm extends FormBase {
  use LayoutBuilderEntityFormTrait {
    buildActions as buildActionsElement;
    saveTasks as saveTasks;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getBaseFormId() : string {
    return 'navigation_layout';
  }
  
  /**
   * {@inheritdoc}
   */
  public function getFormId() : string {
    return 'navigation_layout';
  }
  
  /**
   * The section storage.
   *
   * @var \Drupal\layout_builder\SectionStorageInterface
   */
  protected $sectionStorage;
  
  /**
   * Constructs a new LayoutForm.
   */
  public function __construct(protected LayoutTempstoreRepositoryInterface $layoutTempstoreRepository) {
  }
  
  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) : static {
    return new static($container->get('layout_builder.tempstore_repository'));
  }
  
  /**
   * Handles switching the configuration type selector.
   *
   * @return array
   *   An associative array containing the structure of the form.
   */
  public function enableEditMode($form, FormStateInterface $form_state) : array {
    if ($form_state::hasAnyErrors()) {
      return $form;
    }
    $this->handleFormElementsVisibility($form);
    return $form;
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, ?SectionStorageInterface $section_storage = NULL) {
    $form['#prefix'] = '<div id="js-config-form-wrapper">';
    $form['#suffix'] = '</div>';
    $form['#attributes']['class'][] = 'layout-builder-form';
    $this->sectionStorage = $section_storage;
    $form['layout_builder'] = [
      '#type' => 'layout_builder',
      '#section_storage' => $section_storage,
    ];
    $form['#attached']['library'][] = 'navigation/navigation.layoutBuilder';
    $form['actions'] = [
      'enable_edit_mode' => [
        '#type' => 'submit',
        '#value' => $this->t('Enable edit mode'),
        '#name' => 'enable_edit_mode',
        '#ajax' => [
          'callback' => '::enableEditMode',
          'wrapper' => 'js-config-form-wrapper',
          'effect' => 'fade',
        ],
      ],
      'submit' => [
        '#type' => 'submit',
        '#value' => $this->t('Save'),
        '#name' => 'save',
      ],
    ] + $this->buildActionsElement([]);
    $this->handleFormElementsVisibility($form, FALSE);
    return $form;
  }
  
  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) : void {
    $user_input = $form_state->getUserInput();
    if (isset($user_input['save'])) {
      $this->save($form, $form_state);
    }
  }
  
  /**
   * Saves the Layout changes.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function save(array &$form, FormStateInterface $form_state) : void {
    $this->sectionStorage
      ->save();
    $this->saveTasks($form_state, new TranslatableMarkup('Saved navigation blocks'));
  }
  
  /**
   * Handles visibility of the form elements based on the edit mode status.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param bool $edit_mode_enabled
   *   Boolean indicating whether the Navigation layout edit mode is enabled.
   */
  protected function handleFormElementsVisibility(array &$form, bool $edit_mode_enabled = TRUE) : array {
    // Edit mode elements are visible only in edit mode.
    $form['actions']['submit']['#access'] = $form['actions']['discard_changes']['#access'] = $form['actions']['preview_toggle']['#access'] = $form['actions']['preview_toggle']['toggle_content_preview']['#access'] = $form['layout_builder']['#access'] = $edit_mode_enabled;
    // Edit mode flag element is only visible when edit mode is disabled.
    $form['actions']['enable_edit_mode']['#access'] = !$edit_mode_enabled;
    return $form;
  }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
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 3
DependencySerializationTrait::__wakeup public function 3
FormBase::$configFactory protected property The config factory. 2
FormBase::$elementInfoManager protected property The element info manager.
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 2
FormBase::container private function Returns the service container.
FormBase::elementInfoManager protected function The element info manager.
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::setElementInfoManager public function Sets the element info manager for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 60
LayoutBuilderEntityFormTrait::buildActions protected function Builds the actions for the form. Aliased as: buildActionsElement
LayoutBuilderEntityFormTrait::buildMessageContainer protected function Build the message container.
LayoutBuilderEntityFormTrait::getSectionStorage public function Retrieves the section storage object.
LayoutBuilderEntityFormTrait::redirectOnSubmit public function Form submission handler.
LayoutBuilderEntityFormTrait::saveTasks protected function Performs tasks that are needed during the save process.
LayoutForm::$sectionStorage protected property The section storage.
LayoutForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
LayoutForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
LayoutForm::enableEditMode public function Handles switching the configuration type selector.
LayoutForm::getBaseFormId public function Overrides LayoutBuilderEntityFormTrait::getBaseFormId
LayoutForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
LayoutForm::handleFormElementsVisibility protected function Handles visibility of the form elements based on the edit mode status.
LayoutForm::save public function Saves the Layout changes.
LayoutForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
LayoutForm::__construct public function Constructs a new LayoutForm.
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. 25
MessengerTrait::messenger public function Gets the messenger. 25
MessengerTrait::setMessenger public function Sets the messenger.
PreviewToggleTrait::buildContentPreviewToggle protected function Builds the content preview toggle input.
PreviewToggleTrait::currentUser abstract protected function Gets the current user.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; 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. 3
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. 1

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.