You are here

Home » API reference » Gutenberg 8 » ReusableBlocksController.php

class ReusableBlocksController in Gutenberg 8

Same name and namespace in other branches
  1. 8.2 src/Controller/ReusableBlocksController.php \Drupal\gutenberg\Controller\ReusableBlocksController

Returns responses for our blocks routes.

Hierarchy

Expanded class hierarchy of ReusableBlocksController

File

src/Controller/ReusableBlocksController.php, line 15

Namespace

Drupal\gutenberg\Controller
View source 
class ReusableBlocksController extends ControllerBase {

  /**
   * Returns JSON representing the loaded blocks.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request.
   * @param string $block_id
   *   The reusable block id.
   *
   * @return \Symfony\Component\HttpFoundation\JsonResponse
   *   The JSON response.
   */
  public function load(Request $request, $block_id = NULL) {
    $headers = [
      'Allow' => 'GET, POST, PUT, PATCH, DELETE',
      'Access-Control-Allow-Methods' => 'OPTIONS, GET, POST, PUT, PATCH, DELETE',
      'Access-Control-Allow-Credentials' => 'true',
      'Access-Control-Allow-Headers' => 'Authorization, Content-Type',
    ];
    if ($block_id && $block_id > 0) {
      $block = BlockContent::load($block_id);
      return new JsonResponse([
        'id' => (int) $block
          ->id(),
        'title' => [
          'raw' => $block->info->value,
        ],
        'content' => [
          'protected' => FALSE,
          'raw' => $block->body->value,
        ],
        'type' => 'wp_block',
        'status' => 'publish',
        'slug' => 'reusable_block_' . $block
          ->id(),
        // Kind of a hack but accepted by Gutenberg ;)
        'headers' => $headers,
      ], 200, $headers);
    }
    $ids = \Drupal::entityQuery('block_content')
      ->condition('type', 'reusable_block')
      ->execute();
    $blocks = BlockContent::loadMultiple($ids);
    $result = [];
    foreach ($blocks as $key => $block) {
      $result[] = [
        'id' => (int) $block
          ->id(),
        'title' => [
          'raw' => $block->info->value,
        ],
        'content' => [
          'protected' => FALSE,
          'raw' => $block->body->value,
        ],
        'type' => 'wp_block',
        'status' => 'publish',
        'slug' => 'reusable_block_' . $block
          ->id(),
      ];
    }
    return new JsonResponse($result, 200, $headers);
  }

  /**
   * Saves reusable block.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request.
   * @param string $block_id
   *   The reusable block id.
   *
   * @return \Symfony\Component\HttpFoundation\JsonResponse
   *   The JSON response.
   */
  public function save(Request $request, $block_id = NULL) {
    if ($block_id && $block_id > 0) {
      $data = json_decode($request
        ->getContent(), TRUE);
      $block = BlockContent::load($block_id);
      $block->body->value = $data['content'];
      $block->info->value = $data['title'];
    }
    else {
      $params = $request->request
        ->all();
      $block = BlockContent::create([
        'info' => $params['title'],
        'type' => 'reusable_block',
        'body' => [
          'value' => $params['content'],
          'format' => 'full_html',
        ],
      ]);
    }
    $block
      ->save();
    $headers = [
      'Allow' => 'GET, POST',
      'Access-Control-Allow-Methods' => 'OPTIONS, GET, POST, PUT, PATCH, DELETE',
    ];
    return new JsonResponse([
      'id' => (int) $block
        ->id(),
      'title' => [
        'raw' => $block->info->value,
      ],
      'content' => [
        'block_version' => 1,
        'protected' => FALSE,
        'raw' => $block->body->value,
      ],
      'slug' => 'reusable_block_' . $block
        ->id(),
      'type' => 'wp_block',
      'status' => 'publish',
    ], $block_id && $block_id > 0 ? 200 : 201, $headers);
  }

  /**
   * Delete reusable block.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request.
   * @param string $block_id
   *   The reusable block id.
   *
   * @return \Symfony\Component\HttpFoundation\JsonResponse
   *   The JSON response.
   */
  public function delete(Request $request, $block_id = NULL) {
    $block = BlockContent::load($block_id);
    $block
      ->delete();
    return new JsonResponse([
      'id' => (int) $block_id,
    ]);
  }

  /**
   * Controller routes access callback.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   Current user.
   * @param string $block_id
   *   Block id from route parameter.
   *
   * @return \Drupal\Core\Access\AccessResult
   *   Allowed access result if all conditions are met.
   */
  public function access(AccountInterface $account, $block_id) {
    return AccessResult::allowedIf($account
      ->hasPermission('gutenberg administer') && $this
      ->isBundleOfReusableBlock($block_id));
  }

  /**
   * Creates block from given id and check its bundle.
   *
   * @param string $block_id
   *   Block ID.
   *
   * @return bool
   *   TRUE if the block is bundle of reusable_block, FALSE otherwise.
   */
  protected function isBundleOfReusableBlock($block_id) {
    $block = BlockContent::load($block_id);
    return $block
      ->bundle() === 'reusable_block';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 40
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
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. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
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.
ReusableBlocksController::access public function Controller routes access callback.
ReusableBlocksController::delete public function Delete reusable block.
ReusableBlocksController::isBundleOfReusableBlock protected function Creates block from given id and check its bundle.
ReusableBlocksController::load public function Returns JSON representing the loaded blocks.
ReusableBlocksController::save public function Saves reusable block.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.