panopoly_magic-8.x-2.x-dev/src/Plugin/Block/MagicViewsBlock.php

<?php

namespace Drupal\panopoly_magic\Plugin\Block;

use Drupal\Component\Utility\Xss;
use Drupal\Core\Entity\EntityInterface;
use Drupal\views\Element\View;
use Drupal\views\Plugin\Block\ViewsBlock;

/**
 * Extends ViewsBlock adding extra features from panopoly_magic.
 */
class MagicViewsBlock extends ViewsBlock {

  /**
   * {@inheritdoc}
   */
  public function build() {
    /** @var \Drupal\panopoly_magic\Plugin\views\display\MagicBlock $display */
    $display = $this->view->display_handler;
    $display->preBlockBuild($this);

    $magic_arguments = $display->getOption('magic_arguments') ?: [];

    $args = [];
    foreach ($display->getHandlers('argument') as $argument_name => $argument) {
      // Initialize the argument value. Work around a limitation in
      // \Drupal\views\ViewExecutable::_buildArguments() that skips processing
      // later arguments if an argument with default action "ignore" and no
      // argument is provided.
      $args[$argument_name] = $argument->options['default_action'] == 'ignore' ? 'all' : NULL;

      if (!empty($this->context[$argument_name])) {
        if ($value = $this->context[$argument_name]->getContextValue()) {
          $argument_options = $magic_arguments[$argument_name] ?: [];

          if ($argument_options['type'] === 'context') {
            $context_token = trim($argument_options['context_token'] ?: '');
            if ($context_token !== '') {
              $token_data = [];
              if ($value instanceof EntityInterface) {
                $token_data[$value->getEntityTypeId()] = $value;
              }
              else {
                $token_data['context'] = $value;
              }
              $value = \Drupal::token()->replace($context_token, $token_data, [
                'clear' => TRUE,
              ]);
            }
          }

          // Context values are often entities, but views arguments expect to
          // receive just the entity ID, convert it.
          if ($value instanceof EntityInterface) {
            $value = $value->id();
          }
          $args[$argument_name] = $value;
        }
        else {
          // Need to be able to pass empty values for optional contexts.
          $args[$argument_name] = NULL;
        }
      }
    }

    // We ask ViewExecutable::buildRenderable() to avoid creating a render cache
    // entry for the view output by passing FALSE, because we're going to cache
    // the whole block instead.
    if ($output = $this->view->buildRenderable($this->displayID, array_values($args), FALSE)) {
      // Before returning the block output, convert it to a renderable array
      // with contextual links.
      $this->addContextualLinks($output);

      // Block module expects to get a final render array, without another
      // top-level #pre_render callback. So, here we make sure that Views'
      // #pre_render callback has already been applied.
      $output = View::preRenderViewElement($output);

      // Override the label to the dynamic title configured in the view.
      if (empty($this->configuration['views_label']) && $this->view->getTitle()) {
        $output['#title'] = [
          '#markup' => $this->view->getTitle(),
          '#allowed_tags' => Xss::getHtmlTagList(),
        ];
      }

      // Clear the View title because it's being displayed as the block title.
      $this->view->display_handler->setOption('title', '');
      $this->view->setTitle('');

      // When view_build is empty, the actual render array output for this View
      // is going to be empty. In that case, return just #cache, so that the
      // render system knows the reasons (cache contexts & tags) why this Views
      // block is empty, and can cache it accordingly.
      if (empty($output['view_build'])) {
        $output = ['#cache' => $output['#cache']];
      }

      return $output;
    }

    return [];
  }

}