edit_ui-8.x-1.x-dev/src/Controller/EditUiBlockController.php

<?php

declare(strict_types = 1);

namespace Drupal\edit_ui\Controller;

use Drupal\Core\Controller\ControllerBase;
use Drupal\Component\Utility\Html;
use Drupal\Component\Serialization\Json;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
use Drupal\Core\Ajax\AjaxResponse;
use Drupal\Core\Ajax\CloseDialogCommand;
use Drupal\edit_ui\Ajax\MessageCommand;
use Drupal\edit_ui\Ajax\AddBlockCommand;
use Drupal\block\Entity\Block;

/**
 * Controller managing edit_ui backbone block model.
 */
class EditUiBlockController extends ControllerBase {

  /**
   * The renderer service.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $instance = parent::create($container);
    $instance->renderer = $container->get('renderer');
    return $instance;
  }

  /**
   * Returns all blocks for the current theme.
   *
   * @return \Symfony\Component\HttpFoundation\JsonResponse
   *   The JSON response.
   */
  public function listAction() {
    $rendered = [];

    $theme = $this->config('system.theme')->get('default');

    $blocks = $this->entityTypeManager()->getStorage('block')
      ->loadByProperties(['theme' => $theme]);
    foreach ($blocks as $block_id => $block) {
      $rendered[] = $this->getBlockArray($block_id, $block);
    }

    return new JsonResponse($rendered);
  }

  /**
   * Do nothing.
   *
   * The block creation is managed by the createAction method.
   * This method is needed to avoid an error with Backbone.
   *
   * @return \Symfony\Component\HttpFoundation\JsonResponse
   *   The JSON response.
   */
  public function addAction() {
    return new JsonResponse([]);
  }

  /**
   * Returns the requested block.
   *
   * @param string $block_id
   *   The block instance ID.
   *
   * @return \Symfony\Component\HttpFoundation\JsonResponse
   *   The JSON response.
   */
  public function readAction($block_id) {
    $rendered = $this->getBlockArray($block_id, NULL, TRUE);
    unset($rendered['region']);
    unset($rendered['weight']);
    return new JsonResponse($rendered);
  }

  /**
   * Update given block.
   *
   * @param string $block_id
   *   The block instance ID.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   *
   * @return \Symfony\Component\HttpFoundation\JsonResponse
   *   The JSON response.
   */
  public function updateAction($block_id, Request $request) {
    $block = $this->getBlock($block_id);
    $data = Json::decode($request->getContent());

    if (isset($data['region'])) {
      $block->setRegion($data['region']);
    }
    if (isset($data['weight'])) {
      $block->setWeight($data['weight']);
    }
    if (isset($data['status'])) {
      $block->set('status', (bool) $data['status']);
    }
    if (isset($data['visibility'])) {
      $block->set('visibility', $data['visibility']);
    }
    $block->save();

    $rendered = $this->getBlockArray($block_id);
    return new JsonResponse($rendered);
  }

  /**
   * Delete given block.
   *
   * @param string $block_id
   *   The block instance ID.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   The AJAX response.
   */
  public function deleteAction($block_id) {
    $block = $this->getBlock($block_id);

    try {
      $block->delete();
      $this->messenger()->addStatus($this->t('The block %block has been deleted', ['%block' => $block->label()]));
    }
    catch (\Exception $e) {
      $this->messenger()->addError($e->getMessage());
    }

    $response = new AjaxResponse();
    $response->addCommand(new MessageCommand());

    return $response;
  }

  /**
   * Get the requested block.
   *
   * @param string $block_id
   *   The block instance ID.
   *
   * @return \Drupal\block\BlockInterface
   *   The block entity.
   */
  public function getBlock($block_id) {
    if (empty($block_id)) {
      throw new BadRequestHttpException($this->t('No block id specified.'));
    }

    /** @var \Drupal\block\BlockInterface $block */
    $block = Block::load($block_id);
    if (empty($block)) {
      throw new BadRequestHttpException($this->t('Block not found.'));
    }

    return $block;
  }

  /**
   * Get the array representation requested block.
   *
   * @param mixed $block_id
   *   The block ID.
   * @param mixed $block
   *   The block instance (optionnal).
   * @param bool $with_content
   *   Return the block content or not.
   *
   * @return array
   *   The block array representation.
   */
  public function getBlockArray($block_id, $block = NULL, $with_content = FALSE) {
    if (!($block instanceof Block)) {
      $block = $this->getBlock($block_id);
    }

    $content = NULL;
    if ($with_content) {
      if ($block->access('view')) {
        $content = $this->entityTypeManager()
          ->getViewBuilder($block->getEntityTypeId())
          ->view($block);
        $content = $this->renderer->renderRoot($content);
        $content = (string) $content;
      }
      else {
        $content = '';
      }
    }

    $settings = $block->get('settings');
    return [
      'id'        => $block->getOriginalId(),
      'plugin_id' => $block->getPluginId(),
      'region'    => $block->getRegion(),
      'weight'    => $block->getWeight(),
      'label'     => $block->label(),
      'status'    => $block->status(),
      'html_id'   => Html::getId('block-' . $block_id),
      'provider'  => $settings['provider'],
      'content'   => $content,
    ];
  }

  /**
   * AJAX callback called after a block modal is submitted.
   *
   * @param string $block_id
   *   The block instance ID.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   The AJAX response.
   */
  public function modalAction($block_id) {
    try {
      $response = new AjaxResponse();
      $block    = $this->getBlock($block_id);
    }
    catch (\Exception $e) {
      $this->messenger()->addError($e->getMessage());
    }

    $response->addCommand(new CloseDialogCommand());
    $response->addCommand(new MessageCommand());
    $response->addCommand(new AddBlockCommand($block));

    return $response;
  }

}