localgov_guides-2.1.15/src/Plugin/Block/GuidesAbstractBaseBlock.php

<?php

namespace Drupal\localgov_guides\Plugin\Block;

use Drupal\Core\Access\AccessResult;
use Drupal\Core\Block\BlockBase;
use Drupal\Core\Cache\Cache;
use Drupal\Core\Cache\CacheableDependencyInterface;
use Drupal\Core\Entity\EntityRepositoryInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Routing\CurrentRouteMatch;
use Drupal\Core\Session\AccountInterface;
use Drupal\node\NodeInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Guide contents block.
 *
 * @package Drupal\localgov_guides\Plugin\Block
 * )
 */
abstract class GuidesAbstractBaseBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * Guide overview node.
   *
   * @var \Drupal\node\NodeInterface
   */
  protected $overview;

  /**
   * Array of guide page nodes.
   *
   * @var \Drupal\node\NodeInterface[]
   */
  protected $guidePages;

  /**
   * Guide node being displayed.
   *
   * @var \Drupal\node\NodeInterface
   */
  protected $node;

  /**
   * List format.
   *
   * @var string
   */
  protected $format = '';

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

  /**
   * Initialise new content block instance.
   *
   * @param array $configuration
   *   The plugin configuration.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Routing\CurrentRouteMatch $routeMatch
   *   The route match service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity type manager service.
   * @param \Drupal\Core\Entity\EntityRepositoryInterface $entityRepository
   *   The entity repository.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, protected CurrentRouteMatch $routeMatch, protected EntityTypeManagerInterface $entityTypeManager, protected EntityRepositoryInterface $entityRepository) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);

    if ($this->routeMatch->getParameter('node')) {
      $this->node = $this->routeMatch->getParameter('node');
      if (!$this->node instanceof NodeInterface) {
        $node_storage = $this->entityTypeManager->getStorage('node');
        $this->node = $node_storage->load($this->node);
      }
    }
  }

  /**
   * Set block list of pages and format to display.
   */
  protected function setPages() {
    if (is_null($this->guidePages)) {
      // Initialise guidePages as an array.
      $this->guidePages = [];

      if ($this->node->bundle() == 'localgov_guides_overview') {
        $this->overview = $this->node;
      }
      else {
        $this->overview = $this->node->localgov_guides_parent->entity;
      }

      $this->overview = $this->entityRepository->getTranslationFromContext($this->overview);
      foreach ($this->overview->localgov_guides_pages->referencedEntities() as $guide_page) {
        $this->guidePages[] = $this->entityRepository->getTranslationFromContext($guide_page);
      }
      $this->guidePages = array_filter($this->guidePages, function ($guide_node) {
        return ($guide_node instanceof NodeInterface) && $guide_node->access('view');
      });
      $this->guidePages = array_values($this->guidePages);
      $this->format = $this->overview->localgov_guides_list_format->value;
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function blockAccess(AccountInterface $account) {
    if ($this->node && (
      ($this->node->bundle() == 'localgov_guides_overview' && !empty($this->node->localgov_guides_pages)) ||
      ($this->node->bundle() == 'localgov_guides_page' && !empty($this->node->localgov_guides_parent)&& !empty($this->node->localgov_guides_parent->entity))
    )) {
      return AccessResult::allowed();
    }
    return AccessResult::neutral();
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheContexts() {
    return Cache::mergeContexts(parent::getCacheContexts(), ['user', 'route']);
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {
    $this->setPages();
    $guide_pages_cache_tags = $this->prepareCacheTags(array_merge([$this->overview], $this->guidePages));
    return Cache::mergeTags(parent::getCacheTags(), $guide_pages_cache_tags);
  }

  /**
   * Prepare cache tags for the given items.
   *
   * @param array $cacheable_items
   *   Array of Drupal\Core\Cache\CacheableDependencyInterface objects.
   */
  protected function prepareCacheTags(array $cacheable_items): array {
    $list_of_tag_collections = array_map(function (CacheableDependencyInterface $cacheable_item): array {
      return $cacheable_item->getCacheTags();
    }, $cacheable_items);

    $merged_tags = array_reduce($list_of_tag_collections, [
      Cache::class,
      'mergeTags',
    ], []);
    return $merged_tags;
  }

}