class LayoutBuilderEntityViewDisplayForm

Same name and namespace in other branches
  1. 11.x core/modules/layout_builder/src/Form/LayoutBuilderEntityViewDisplayForm.php \Drupal\layout_builder\Form\LayoutBuilderEntityViewDisplayForm

Edit form for the LayoutBuilderEntityViewDisplay entity type.

@internal Form classes are internal.

Hierarchy

Expanded class hierarchy of LayoutBuilderEntityViewDisplayForm

1 file declares its use of LayoutBuilderEntityViewDisplayForm
layout_builder.module in core/modules/layout_builder/layout_builder.module
Provides hook implementations for Layout Builder.

File

core/modules/layout_builder/src/Form/LayoutBuilderEntityViewDisplayForm.php, line 19

Namespace

Drupal\layout_builder\Form
View source
class LayoutBuilderEntityViewDisplayForm extends EntityViewDisplayEditForm {
  
  /**
   * The entity being used by this form.
   *
   * @var \Drupal\layout_builder\Entity\LayoutEntityDisplayInterface
   */
  protected $entity;
  
  /**
   * The storage section.
   *
   * @var \Drupal\layout_builder\DefaultsSectionStorageInterface
   */
  protected $sectionStorage;
  
  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, SectionStorageInterface $section_storage = NULL) {
    $this->sectionStorage = $section_storage;
    return parent::buildForm($form, $form_state);
  }
  
  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $form = parent::form($form, $form_state);
    // Remove the Layout Builder field from the list.
    $form['#fields'] = array_diff($form['#fields'], [
      OverridesSectionStorage::FIELD_NAME,
    ]);
    unset($form['fields'][OverridesSectionStorage::FIELD_NAME]);
    $is_enabled = $this->entity
      ->isLayoutBuilderEnabled();
    if ($is_enabled) {
      // Hide the table of fields.
      $form['fields']['#access'] = FALSE;
      $form['#fields'] = [];
      $form['#extra'] = [];
    }
    $form['manage_layout'] = [
      '#type' => 'link',
      '#title' => $this->t('Manage layout'),
      '#weight' => -10,
      '#attributes' => [
        'class' => [
          'button',
        ],
      ],
      '#url' => $this->sectionStorage
        ->getLayoutBuilderUrl(),
      '#access' => $is_enabled,
    ];
    $form['layout'] = [
      '#type' => 'details',
      '#open' => TRUE,
      '#title' => $this->t('Layout options'),
      '#tree' => TRUE,
    ];
    $form['layout']['enabled'] = [
      '#type' => 'checkbox',
      '#title' => $this->t('Use Layout Builder'),
      '#default_value' => $is_enabled,
    ];
    $form['#entity_builders']['layout_builder'] = '::entityFormEntityBuild';
    // @todo Expand to work for all view modes in
    //   https://www.drupal.org/node/2907413.
    if ($this->isCanonicalMode($this->entity
      ->getMode())) {
      $entity_type = $this->entityTypeManager
        ->getDefinition($this->entity
        ->getTargetEntityTypeId());
      $form['layout']['allow_custom'] = [
        '#type' => 'checkbox',
        '#title' => $this->t('Allow each @entity to have its layout customized.', [
          '@entity' => $entity_type->getSingularLabel(),
        ]),
        '#default_value' => $this->entity
          ->isOverridable(),
        '#states' => [
          'disabled' => [
            ':input[name="layout[enabled]"]' => [
              'checked' => FALSE,
            ],
          ],
          'invisible' => [
            ':input[name="layout[enabled]"]' => [
              'checked' => FALSE,
            ],
          ],
        ],
      ];
      if (!$is_enabled) {
        $form['layout']['allow_custom']['#attributes']['disabled'] = 'disabled';
      }
      // Prevent turning off overrides while any exist.
      if ($this->hasOverrides($this->entity)) {
        $form['layout']['enabled']['#disabled'] = TRUE;
        $form['layout']['enabled']['#description'] = $this->t('You must revert all customized layouts of this display before you can disable this option.');
        $form['layout']['allow_custom']['#disabled'] = TRUE;
        $form['layout']['allow_custom']['#description'] = $this->t('You must revert all customized layouts of this display before you can disable this option.');
        unset($form['layout']['allow_custom']['#states']);
        unset($form['#entity_builders']['layout_builder']);
      }
    }
    else {
      $form['layout']['allow_custom'] = [
        '#type' => 'value',
        '#value' => $this->entity
          ->isOverridable(),
      ];
    }
    return $form;
  }
  
  /**
   * Determines if the mode is used by the canonical route.
   *
   * @param string $mode
   *   The view mode.
   *
   * @return bool
   *   TRUE if the mode is valid, FALSE otherwise.
   */
  protected function isCanonicalMode($mode) {
    // @todo This is a convention core uses but is not a given, nor is it easily
    //   introspectable. Address in https://www.drupal.org/node/2907413.
    $canonical_mode = 'full';
    if ($mode === $canonical_mode) {
      return TRUE;
    }
    // The default mode is valid if the canonical mode is not enabled.
    if ($mode === 'default') {
      $query = $this->entityTypeManager
        ->getStorage($this->entity
        ->getEntityTypeId())
        ->getQuery()
        ->condition('targetEntityType', $this->entity
        ->getTargetEntityTypeId())
        ->condition('bundle', $this->entity
        ->getTargetBundle())
        ->condition('status', TRUE)
        ->condition('mode', $canonical_mode);
      return !$query->count()
        ->execute();
    }
    return FALSE;
  }
  
  /**
   * Determines if the defaults have any overrides.
   *
   * @param \Drupal\layout_builder\Entity\LayoutEntityDisplayInterface $display
   *   The entity display.
   *
   * @return bool
   *   TRUE if there are any overrides of this default, FALSE otherwise.
   */
  protected function hasOverrides(LayoutEntityDisplayInterface $display) {
    if (!$display->isOverridable()) {
      return FALSE;
    }
    $entity_type = $this->entityTypeManager
      ->getDefinition($display->getTargetEntityTypeId());
    $query = $this->entityTypeManager
      ->getStorage($display->getTargetEntityTypeId())
      ->getQuery()
      ->accessCheck(FALSE)
      ->exists(OverridesSectionStorage::FIELD_NAME);
    if ($bundle_key = $entity_type->getKey('bundle')) {
      $query->condition($bundle_key, $display->getTargetBundle());
    }
    return (bool) $query->count()
      ->execute();
  }
  
  /**
   * {@inheritdoc}
   */
  protected function copyFormValuesToEntity(EntityInterface $entity, array $form, FormStateInterface $form_state) {
    // Do not process field values if Layout Builder is or will be enabled.
    $set_enabled = (bool) $form_state->getValue([
      'layout',
      'enabled',
    ], FALSE);
    /** @var \Drupal\layout_builder\Entity\LayoutEntityDisplayInterface $entity */
    $already_enabled = $entity->isLayoutBuilderEnabled();
    if ($already_enabled || $set_enabled) {
      $form['#fields'] = [];
      $form['#extra'] = [];
    }
    parent::copyFormValuesToEntity($entity, $form, $form_state);
  }
  
  /**
   * Entity builder for layout options on the entity view display form.
   */
  public function entityFormEntityBuild($entity_type_id, LayoutEntityDisplayInterface $display, &$form, FormStateInterface &$form_state) {
    $set_enabled = (bool) $form_state->getValue([
      'layout',
      'enabled',
    ], FALSE);
    $already_enabled = $display->isLayoutBuilderEnabled();
    if ($set_enabled) {
      $overridable = (bool) $form_state->getValue([
        'layout',
        'allow_custom',
      ], FALSE);
      $display->setOverridable($overridable);
      if (!$already_enabled) {
        $display->enableLayoutBuilder();
      }
    }
    elseif ($already_enabled) {
      $form_state->setRedirectUrl($this->sectionStorage
        ->getLayoutBuilderUrl('disable'));
    }
  }
  
  /**
   * {@inheritdoc}
   */
  protected function buildFieldRow(FieldDefinitionInterface $field_definition, array $form, FormStateInterface $form_state) {
    if ($this->entity
      ->isLayoutBuilderEnabled()) {
      return [];
    }
    return parent::buildFieldRow($field_definition, $form, $form_state);
  }
  
  /**
   * {@inheritdoc}
   */
  protected function buildExtraFieldRow($field_id, $extra_field) {
    if ($this->entity
      ->isLayoutBuilderEnabled()) {
      return [];
    }
    return parent::buildExtraFieldRow($field_id, $extra_field);
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
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::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function
DependencySerializationTrait::__sleep public function
DependencySerializationTrait::__wakeup public function #[\ReturnTypeWillChange]
DependencySerializationTrait::__wakeup public function #[\ReturnTypeWillChange]
EntityDisplayFormBase::$entityDisplayRepository protected property The entity display repository.
EntityDisplayFormBase::$entityDisplayRepository protected property The entity display repository.
EntityDisplayFormBase::$entityFieldManager protected property The entity field manager.
EntityDisplayFormBase::$entityFieldManager protected property The entity field manager.
EntityDisplayFormBase::$fieldTypes protected property A list of field types.
EntityDisplayFormBase::$fieldTypes protected property A list of field types.
EntityDisplayFormBase::$pluginManager protected property The widget or formatter plugin manager.
EntityDisplayFormBase::$pluginManager protected property The widget or formatter plugin manager.
EntityDisplayFormBase::getApplicablePluginOptions protected function Returns an array of applicable widget or formatter options for a field.
EntityDisplayFormBase::getDisplays protected function Returns entity (form) displays for the current entity display type.
EntityDisplayFormBase::getDisplayStatuses protected function Returns form or view modes statuses for the bundle used by this form.
EntityDisplayFormBase::getEntityFromRouteMatch public function
EntityDisplayFormBase::getExtraFields protected function Returns the extra fields of the entity type and bundle used by this form.
EntityDisplayFormBase::getFieldDefinitions protected function Collects the definitions of fields whose display is configurable.
EntityDisplayFormBase::getRegionOptions public function Returns an associative array of all regions.
EntityDisplayFormBase::getRegions public function Get the regions needed to create the overview form.
EntityDisplayFormBase::getRowRegion public function Returns the region to which a row in the display overview belongs.
EntityDisplayFormBase::multistepAjax public function Ajax handler for multistep buttons.
EntityDisplayFormBase::multistepSubmit public function Form submission handler for multistep buttons.
EntityDisplayFormBase::saveDisplayStatuses protected function Saves the updated display mode statuses.
EntityDisplayFormBase::submitForm public function
EntityDisplayFormBase::__construct public function Constructs a new EntityDisplayFormBase.
EntityForm::$entityTypeManager protected property The entity type manager. 1
EntityForm::$entityTypeManager protected property The entity type manager. 1
EntityForm::$entityTypeManager protected property The entity type manager. 1
EntityForm::$entityTypeManager protected property The entity type manager. 1
EntityForm::$moduleHandler protected property The module handler service.
EntityForm::$moduleHandler protected property The module handler service.
EntityForm::$operation protected property The name of the current operation.
EntityForm::$operation protected property The name of the current operation.
EntityForm::actions protected function Returns an array of supported actions for the current entity form. 7
EntityForm::actions protected function Returns an array of supported actions for the current entity form. 7
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data.
EntityForm::buildEntity public function 1
EntityForm::buildEntity public function 1
EntityForm::getBaseFormId public function 2
EntityForm::getBaseFormId public function 2
EntityForm::getEntity public function
EntityForm::getFormId public function 4
EntityForm::getFormId public function 4
EntityForm::getOperation public function
EntityForm::init protected function Initialize the form state and the entity before the first form build.
EntityForm::prepareEntity protected function Prepares the entity object before the form is built first.
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::save public function 9
EntityForm::save public function 9
EntityForm::setEntity public function
EntityForm::setEntityTypeManager public function
EntityForm::setModuleHandler public function
EntityForm::setOperation public function
EntityViewDisplayEditForm::$displayContext protected property
EntityViewDisplayEditForm::$displayContext protected property
EntityViewDisplayEditForm::alterSettingsSummary protected function
EntityViewDisplayEditForm::create public static function
EntityViewDisplayEditForm::getDefaultPlugin protected function
EntityViewDisplayEditForm::getDisplayModeOptions protected function
EntityViewDisplayEditForm::getDisplayModes protected function
EntityViewDisplayEditForm::getDisplayModesLink protected function
EntityViewDisplayEditForm::getEntityDisplay protected function
EntityViewDisplayEditForm::getFieldLabelOptions protected function Returns an array of visibility options for field labels.
EntityViewDisplayEditForm::getOverviewUrl protected function
EntityViewDisplayEditForm::getTableHeader protected function
EntityViewDisplayEditForm::thirdPartySettingsForm protected function
FormBase::$configFactory protected property The config factory.
FormBase::$configFactory protected property The config factory.
FormBase::$requestStack protected property The request stack.
FormBase::$requestStack protected property The request stack.
FormBase::$routeMatch protected property The route match.
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form.
FormBase::configFactory protected function Gets the config factory for this form.
FormBase::container private function Returns the service container.
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
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::redirect protected function Returns a redirect response object for the specified route.
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 17
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 17
LayoutBuilderEntityViewDisplayForm::$entity protected property The entity being used by this form. Overrides EntityDisplayFormBase::$entity
LayoutBuilderEntityViewDisplayForm::$entity protected property The entity being used by this form. Overrides EntityDisplayFormBase::$entity
LayoutBuilderEntityViewDisplayForm::$sectionStorage protected property The storage section.
LayoutBuilderEntityViewDisplayForm::$sectionStorage protected property The storage section.
LayoutBuilderEntityViewDisplayForm::buildExtraFieldRow protected function Builds the table row structure for a single extra field. Overrides EntityViewDisplayEditForm::buildExtraFieldRow
LayoutBuilderEntityViewDisplayForm::buildFieldRow protected function Builds the table row structure for a single field. Overrides EntityViewDisplayEditForm::buildFieldRow
LayoutBuilderEntityViewDisplayForm::buildForm public function Form constructor. Overrides EntityForm::buildForm
LayoutBuilderEntityViewDisplayForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties. Overrides EntityDisplayFormBase::copyFormValuesToEntity
LayoutBuilderEntityViewDisplayForm::entityFormEntityBuild public function Entity builder for layout options on the entity view display form.
LayoutBuilderEntityViewDisplayForm::form public function Gets the actual form array to be built. Overrides EntityDisplayFormBase::form
LayoutBuilderEntityViewDisplayForm::hasOverrides protected function Determines if the defaults have any overrides.
LayoutBuilderEntityViewDisplayForm::isCanonicalMode protected function Determines if the mode is used by the canonical route.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 7
MessengerTrait::$messenger protected property The messenger. 7
MessengerTrait::$messenger protected property The messenger. 7
MessengerTrait::$messenger protected property The messenger. 7
MessengerTrait::messenger public function Gets the messenger. 7
MessengerTrait::messenger public function Gets the messenger. 7
MessengerTrait::messenger public function Gets the messenger. 7
MessengerTrait::messenger public function Gets the messenger. 7
MessengerTrait::setMessenger public function Sets the messenger.
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service.
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
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::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service.
StringTranslationTrait::$stringTranslation protected property The string translation service.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
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::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.

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