UpdateBlockForm.php

Same filename in other branches
  1. 9 core/modules/layout_builder/src/Form/UpdateBlockForm.php
  2. 10 core/modules/layout_builder/src/Form/UpdateBlockForm.php
  3. 11.x core/modules/layout_builder/src/Form/UpdateBlockForm.php

Namespace

Drupal\layout_builder\Form

File

core/modules/layout_builder/src/Form/UpdateBlockForm.php

View source
<?php

namespace Drupal\layout_builder\Form;

use Drupal\Core\Form\FormStateInterface;
use Drupal\layout_builder\LayoutBuilderHighlightTrait;
use Drupal\layout_builder\SectionStorageInterface;

/**
 * Provides a form to update a block.
 *
 * @internal
 *   Form classes are internal.
 */
class UpdateBlockForm extends ConfigureBlockFormBase {
    use LayoutBuilderHighlightTrait;
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'layout_builder_update_block';
    }
    
    /**
     * Builds the block form.
     *
     * @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.
     * @param \Drupal\layout_builder\SectionStorageInterface $section_storage
     *   The section storage being configured.
     * @param int $delta
     *   The delta of the section.
     * @param string $region
     *   The region of the block.
     * @param string $uuid
     *   The UUID of the block being updated.
     *
     * @return array
     *   The form array.
     */
    public function buildForm(array $form, FormStateInterface $form_state, SectionStorageInterface $section_storage = NULL, $delta = NULL, $region = NULL, $uuid = NULL) {
        $component = $section_storage->getSection($delta)
            ->getComponent($uuid);
        $form['#attributes']['data-layout-builder-target-highlight-id'] = $this->blockUpdateHighlightId($uuid);
        return $this->doBuildForm($form, $form_state, $section_storage, $delta, $component);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function submitLabel() {
        return $this->t('Update');
    }

}

Classes

Title Deprecated Summary
UpdateBlockForm Provides a form to update a block.

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