BlockGroup.php in Block Group 8

Namespace

Drupal\blockgroup\Plugin\Block

File

src/Plugin/Block/BlockGroup.php

<?php

namespace Drupal\blockgroup\Plugin\Block;

use Drupal\Component\Plugin\ContextAwarePluginInterface;
use Drupal\Core\Block\BlockBase;
use Drupal\Core\Block\MainContentBlockPluginInterface;
use Drupal\Core\Cache\CacheableMetadata;
use Drupal\Core\Controller\TitleResolverInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Plugin\Context\ContextHandlerInterface;
use Drupal\Core\Plugin\Context\ContextRepositoryInterface;
use Drupal\Core\Render\RendererInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\Theme\ThemeManagerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;

/**
 * Provides a 'BlockGroup' block.
 *
 * @Block(
 *  id = "block_group",
 *  admin_label = @Translation("Block group"),
 *  deriver = "Drupal\blockgroup\Plugin\Derivative\BlockGroups"
 * )
 */
class BlockGroup extends BlockBase implements ContainerFactoryPluginInterface, MainContentBlockPluginInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The theme manager.
   *
   * @var \Drupal\Core\Theme\ThemeManagerInterface
   */
  protected $themeManager;

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

  /**
   * The context repository.
   *
   * @var \Drupal\Core\Plugin\Context\ContextRepositoryInterface
   */
  protected $contextRepository;

  /**
   * The context handler.
   *
   * @var \Drupal\Core\Plugin\Context\ContextHandlerInterface
   */
  protected $contextHandler;

  /**
   * The title resolver.
   *
   * @var \Drupal\Core\Controller\TitleResolverInterface
   */
  protected $titleResolver;

  /**
   * The route match.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * The current Request object.
   *
   * @var \Symfony\Component\HttpFoundation\Request
   */
  protected $request;

  /**
   * The render array representing the main page content.
   *
   * @var array
   */
  protected $mainContent;

  /**
   * {@inheritdoc}
   */
  public function setMainContent(array $main_content) {
    $this->mainContent = $main_content;
  }

  /**
   * Constructs a new BlockContentBlock.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin ID for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Theme\ThemeManagerInterface $theme_manager
   *   The theme manager.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer service.
   * @param \Drupal\Core\Plugin\Context\ContextRepositoryInterface $context_repository
   *   The context repository.
   * @param \Drupal\Core\Plugin\Context\ContextHandlerInterface $context_handler
   *   The context handler.
   * @param \Drupal\Core\Controller\TitleResolverInterface $title_resolver
   *   The title resolver.
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The current route match.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, ThemeManagerInterface $theme_manager, RendererInterface $renderer, ContextRepositoryInterface $context_repository, ContextHandlerInterface $context_handler, TitleResolverInterface $title_resolver, RouteMatchInterface $route_match, Request $request) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entity_type_manager;
    $this->themeManager = $theme_manager;
    $this->renderer = $renderer;
    $this->contextRepository = $context_repository;
    $this->contextHandler = $context_handler;
    $this->titleResolver = $title_resolver;
    $this->routeMatch = $route_match;
    $this->request = $request;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'), $container
      ->get('theme.manager'), $container
      ->get('renderer'), $container
      ->get('context.repository'), $container
      ->get('context.handler'), $container
      ->get('title_resolver'), $container
      ->get('current_route_match'), $container
      ->get('request_stack')
      ->getCurrentRequest());
  }

  /**
   * {@inheritdoc}
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   */
  public function build() {
    $blockGroupStorage = $this->entityTypeManager
      ->getStorage('block_group_content');
    $renderedBlocks = [];
    $derivativeId = $this
      ->getDerivativeId();

    /** @var \Drupal\blockgroup\BlockGroupContentInterface $blockGroup */
    $blockGroup = $blockGroupStorage
      ->load($derivativeId);

    /** @var \Drupal\block\BlockInterface[] $blocks */
    $blocks = $this->entityTypeManager
      ->getStorage('block')
      ->loadByProperties([
      'theme' => $this->themeManager
        ->getActiveTheme()
        ->getName(),
      'region' => $blockGroup
        ->id(),
    ]);
    uasort($blocks, 'Drupal\\block\\Entity\\Block::sort');
    foreach ($blocks as $block) {

      // Special condition for Main block.
      if ($block
        ->getPluginId() == 'system_main_block') {
        $renderedBlocks[$block
          ->id()] = $this->mainContent;
      }
      elseif ($block
        ->getPluginId() == 'page_title_block') {
        $title = $this->titleResolver
          ->getTitle($this->request, $this->routeMatch
          ->getRouteObject());
        $renderedBlocks[$block
          ->id()] = [
          '#type' => 'page_title',
          '#title' => $title,
          '#weight' => $block
            ->getWeight(),
        ];
      }
      else {

        /** @var \Drupal\Core\Access\AccessResultInterface $accessResult */
        $accessResult = $block
          ->access('view', NULL, TRUE);
        if ($accessResult
          ->isAllowed()) {

          // Inject runtime contexts.
          // @see \Drupal\block\BlockViewBuilder::buildPreRenderableBlock().
          $blockPlugin = $block
            ->getPlugin();
          if ($blockPlugin instanceof ContextAwarePluginInterface) {
            $contexts = $this->contextRepository
              ->getRuntimeContexts(array_values($blockPlugin
              ->getContextMapping()));
            $this->contextHandler
              ->applyContextMapping($blockPlugin, $contexts);
          }
          $renderedBlocks[$block
            ->id()] = $this->entityTypeManager
            ->getViewBuilder('block')
            ->view($block);
        }
        $this->renderer
          ->addCacheableDependency($renderedBlocks, $accessResult);
      }
      $this->renderer
        ->addCacheableDependency($renderedBlocks, $block);
    }
    $this->renderer
      ->addCacheableDependency($renderedBlocks, $blockGroup);
    $blockDefinition = $this->entityTypeManager
      ->getDefinition('block');
    $listCacheability = new CacheableMetadata();
    $listCacheability
      ->addCacheTags($blockDefinition
      ->getListCacheTags());
    $listCacheability
      ->addCacheContexts($blockDefinition
      ->getListCacheContexts());
    $this->renderer
      ->addCacheableDependency($renderedBlocks, $listCacheability);
    return $renderedBlocks;
  }

}

Classes

Name	Description
BlockGroup	Provides a 'BlockGroup' block.