class MoveBlockController in Drupal 9

Defines a controller to move a block.

@internal Controller classes are internal.

Hierarchy

• class \Drupal\layout_builder\Controller\MoveBlockController implements ContainerInjectionInterface uses LayoutRebuildTrait

File

core/modules/layout_builder/src/Controller/MoveBlockController.php, line 16

Namespace

Drupal\layout_builder\Controller

class MoveBlockController implements ContainerInjectionInterface {
  use LayoutRebuildTrait;

  /**
   * The layout tempstore repository.
   *
   * @var \Drupal\layout_builder\LayoutTempstoreRepositoryInterface
   */
  protected $layoutTempstoreRepository;

  /**
   * LayoutController constructor.
   *
   * @param \Drupal\layout_builder\LayoutTempstoreRepositoryInterface $layout_tempstore_repository
   *   The layout tempstore repository.
   */
  public function __construct(LayoutTempstoreRepositoryInterface $layout_tempstore_repository) {
    $this->layoutTempstoreRepository = $layout_tempstore_repository;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('layout_builder.tempstore_repository'));
  }

  /**
   * Moves a block to another region.
   *
   * @param \Drupal\layout_builder\SectionStorageInterface $section_storage
   *   The section storage.
   * @param int $delta_from
   *   The delta of the original section.
   * @param int $delta_to
   *   The delta of the destination section.
   * @param string $region_to
   *   The new region for this block.
   * @param string $block_uuid
   *   The UUID for this block.
   * @param string|null $preceding_block_uuid
   *   (optional) If provided, the UUID of the block to insert this block after.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   An AJAX response.
   */
  public function build(SectionStorageInterface $section_storage, int $delta_from, int $delta_to, $region_to, $block_uuid, $preceding_block_uuid = NULL) {
    $section = $section_storage
      ->getSection($delta_from);
    $component = $section
      ->getComponent($block_uuid);
    $section
      ->removeComponent($block_uuid);

    // If the block is moving from one section to another, update the original
    // section and load the new one.
    if ($delta_from !== $delta_to) {
      $section = $section_storage
        ->getSection($delta_to);
    }

    // If a preceding block was specified, insert after that. Otherwise add the
    // block to the front.
    $component
      ->setRegion($region_to);
    if (isset($preceding_block_uuid)) {
      $section
        ->insertAfterComponent($preceding_block_uuid, $component);
    }
    else {
      $section
        ->insertComponent(0, $component);
    }
    $this->layoutTempstoreRepository
      ->set($section_storage);
    return $this
      ->rebuildLayout($section_storage);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
LayoutRebuildTrait::rebuildAndClose	protected	function	Rebuilds the layout.
LayoutRebuildTrait::rebuildLayout	protected	function	Rebuilds the layout.
MoveBlockController::$layoutTempstoreRepository	protected	property	The layout tempstore repository.
MoveBlockController::build	public	function	Moves a block to another region.
MoveBlockController::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
MoveBlockController::__construct	public	function	LayoutController constructor.