class AddBlockForm

Same name in other branches
  1. 9 core/modules/layout_builder/src/Form/AddBlockForm.php \Drupal\layout_builder\Form\AddBlockForm
  2. 8.9.x core/modules/layout_builder/src/Form/AddBlockForm.php \Drupal\layout_builder\Form\AddBlockForm
  3. 10 core/modules/layout_builder/src/Form/AddBlockForm.php \Drupal\layout_builder\Form\AddBlockForm

Provides a form to add a block.

@internal Form classes are internal.

Hierarchy

Expanded class hierarchy of AddBlockForm

1 string reference to 'AddBlockForm'
layout_builder.routing.yml in core/modules/layout_builder/layout_builder.routing.yml
core/modules/layout_builder/layout_builder.routing.yml

File

core/modules/layout_builder/src/Form/AddBlockForm.php, line 16

Namespace

Drupal\layout_builder\Form
View source
class AddBlockForm extends ConfigureBlockFormBase {
    use LayoutBuilderHighlightTrait;
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'layout_builder_add_block';
    }
    
    /**
     * {@inheritdoc}
     */
    protected function submitLabel() {
        return $this->t('Add block');
    }
    
    /**
     * Builds the form for the block.
     *
     * @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|null $plugin_id
     *   The plugin ID of the block to add.
     *
     * @return array
     *   The form array.
     */
    public function buildForm(array $form, FormStateInterface $form_state, ?SectionStorageInterface $section_storage = NULL, $delta = NULL, $region = NULL, $plugin_id = NULL) {
        // Only generate a new component once per form submission.
        if (!($component = $form_state->get('layout_builder__component'))) {
            $component = new SectionComponent($this->uuidGenerator
                ->generate(), $region, [
                'id' => $plugin_id,
            ]);
            $section_storage->getSection($delta)
                ->appendComponent($component);
            $form_state->set('layout_builder__component', $component);
        }
        $form['#attributes']['data-layout-builder-target-highlight-id'] = $this->blockAddHighlightId($delta, $region);
        return $this->doBuildForm($form, $form_state, $section_storage, $delta, $component);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
AddBlockForm::buildForm public function Builds the form for the block. Overrides FormInterface::buildForm
AddBlockForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AddBlockForm::submitLabel protected function Returns the label for the submit button. Overrides ConfigureBlockFormBase::submitLabel
AjaxFormHelperTrait::ajaxSubmit public function Submit form dialog #ajax callback.
AjaxHelperTrait::getRequestWrapperFormat protected function Gets the wrapper format of the current request.
AjaxHelperTrait::isAjax protected function Determines if the current request is via AJAX.
ConfigureBlockFormBase::$block protected property The plugin being configured.
ConfigureBlockFormBase::$blockManager protected property The block manager.
ConfigureBlockFormBase::$delta protected property The field delta.
ConfigureBlockFormBase::$layoutTempstoreRepository protected property The layout tempstore repository.
ConfigureBlockFormBase::$pluginFormFactory protected property The plugin form manager.
ConfigureBlockFormBase::$region protected property The current region.
ConfigureBlockFormBase::$sectionStorage protected property The section storage.
ConfigureBlockFormBase::$uuid protected property The UUID of the component.
ConfigureBlockFormBase::$uuidGenerator protected property The UUID generator.
ConfigureBlockFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create
ConfigureBlockFormBase::doBuildForm public function Builds the form for the block.
ConfigureBlockFormBase::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId
ConfigureBlockFormBase::getCurrentComponent public function Retrieves the current component being edited by the form.
ConfigureBlockFormBase::getCurrentSection public function Retrieves the current layout section being edited by the form.
ConfigureBlockFormBase::getPluginForm protected function Retrieves the plugin form for a given block.
ConfigureBlockFormBase::getSectionStorage public function Retrieves the section storage object.
ConfigureBlockFormBase::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ConfigureBlockFormBase::successfulAjaxSubmit protected function Allows the form to respond to a successful AJAX submission. Overrides AjaxFormHelperTrait::successfulAjaxSubmit
ConfigureBlockFormBase::validateForm public function Form validation handler. Overrides FormBase::validateForm
ConfigureBlockFormBase::__construct public function Constructs a new block form.
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginAssignmentTrait::t abstract protected function Ensures the t() method is available.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 2
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::currentUser protected function Gets the current user. 2
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.
LayoutBuilderContextTrait::$contextRepository protected property The context repository.
LayoutBuilderContextTrait::contextRepository protected function Gets the context repository service.
LayoutBuilderContextTrait::getPopulatedContexts protected function Returns all populated contexts, both global and section-storage-specific.
LayoutBuilderHighlightTrait::blockAddHighlightId protected function Provides the ID used to highlight the active Layout Builder UI element.
LayoutBuilderHighlightTrait::blockUpdateHighlightId protected function Provides the ID used to highlight the active Layout Builder UI element.
LayoutBuilderHighlightTrait::sectionAddHighlightId protected function Provides the ID used to highlight the active Layout Builder UI element.
LayoutBuilderHighlightTrait::sectionUpdateHighlightId protected function Provides the ID used to highlight the active Layout Builder UI element.
LayoutRebuildTrait::rebuildAndClose protected function Rebuilds the layout.
LayoutRebuildTrait::rebuildLayout protected function Rebuilds the layout.
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. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
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. 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
WorkspaceSafeFormTrait::$workspaceInfo protected property The workspace information service.
WorkspaceSafeFormTrait::getSectionStorageFromFormState protected function Retrieves the section storage from a form state object, if it exists.
WorkspaceSafeFormTrait::getWorkspaceInfo protected function Retrieves the workspace information service.
WorkspaceSafeFormTrait::isWorkspaceSafeEntity protected function Determines whether an entity used in a form is workspace-safe.
WorkspaceSafeFormTrait::isWorkspaceSafeEntityType protected function Determines whether an entity type used in a form is workspace-safe.
WorkspaceSafeFormTrait::isWorkspaceSafeForm public function Determines whether the current form is safe to be submitted in a workspace.

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