LayoutRebuildTrait.php

Same filename in other branches
  1. 8.9.x core/modules/layout_builder/src/Controller/LayoutRebuildTrait.php
  2. 10 core/modules/layout_builder/src/Controller/LayoutRebuildTrait.php
  3. 11.x core/modules/layout_builder/src/Controller/LayoutRebuildTrait.php

Namespace

Drupal\layout_builder\Controller

File

core/modules/layout_builder/src/Controller/LayoutRebuildTrait.php

View source
<?php

namespace Drupal\layout_builder\Controller;

use Drupal\Core\Ajax\AjaxResponse;
use Drupal\Core\Ajax\CloseDialogCommand;
use Drupal\Core\Ajax\ReplaceCommand;
use Drupal\layout_builder\SectionStorageInterface;

/**
 * Provides AJAX responses to rebuild the Layout Builder.
 */
trait LayoutRebuildTrait {
    
    /**
     * Rebuilds the layout.
     *
     * @param \Drupal\layout_builder\SectionStorageInterface $section_storage
     *   The section storage.
     *
     * @return \Drupal\Core\Ajax\AjaxResponse
     *   An AJAX response to either rebuild the layout and close the dialog, or
     *   reload the page.
     */
    protected function rebuildAndClose(SectionStorageInterface $section_storage) {
        $response = $this->rebuildLayout($section_storage);
        $response->addCommand(new CloseDialogCommand('#drupal-off-canvas'));
        return $response;
    }
    
    /**
     * Rebuilds the layout.
     *
     * @param \Drupal\layout_builder\SectionStorageInterface $section_storage
     *   The section storage.
     *
     * @return \Drupal\Core\Ajax\AjaxResponse
     *   An AJAX response to either rebuild the layout and close the dialog, or
     *   reload the page.
     */
    protected function rebuildLayout(SectionStorageInterface $section_storage) {
        $response = new AjaxResponse();
        $layout = [
            '#type' => 'layout_builder',
            '#section_storage' => $section_storage,
        ];
        $response->addCommand(new ReplaceCommand('#layout-builder', $layout));
        return $response;
    }

}

Traits

Title Deprecated Summary
LayoutRebuildTrait Provides AJAX responses to rebuild the Layout Builder.

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