You are here

Home » API reference » Views entity embed 2.0.x » ViewsEmbedFilter.php

class ViewsEmbedFilter in Views entity embed 2.0.x

Same name and namespace in other branches
  1. 8 src/Plugin/Filter/ViewsEmbedFilter.php \Drupal\views_entity_embed\Plugin\Filter\ViewsEmbedFilter

Provides a filter to display embedded entities based on data attributes.

Plugin annotation


@Filter(
  id = "views_embed",
  title = @Translation("Display embedded views"),
  description = @Translation("Embeds views using data attributes: data-view-name, data-view-display, and data-view-attributes."),
  type = Drupal\filter\Plugin\FilterInterface::TYPE_TRANSFORM_REVERSIBLE
)

Hierarchy

Expanded class hierarchy of ViewsEmbedFilter

File

src/Plugin/Filter/ViewsEmbedFilter.php, line 28

Namespace

Drupal\views_entity_embed\Plugin\Filter
View source 
class ViewsEmbedFilter extends FilterBase implements ContainerFactoryPluginInterface {
  use DomHelperTrait;

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

  /**
   * Constructs a ViewsEmbedFilter object.
   *
   * @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\Render\RendererInterface $renderer
   *   The renderer.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, RendererInterface $renderer) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->renderer = $renderer;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('renderer'));
  }

  /**
   * {@inheritdoc}
   */
  public function process($text, $langcode) {
    $result = new FilterProcessResult($text);
    if (strpos($text, 'data-view-name') !== FALSE && strpos($text, 'data-view-display') !== FALSE) {
      $dom = Html::load($text);
      $xpath = new \DOMXPath($dom);
      foreach ($xpath
        ->query('//drupal-views[@data-view-name and @data-view-display]') as $node) {
        $render_view = '';
        try {
          $build = $this
            ->buildViewsEmbed($node);
          $render_view = $this->renderer
            ->executeInRenderContext(new RenderContext(), function () use (&$build) {
            return $this->renderer
              ->render($build);
          });
          $result = $result
            ->merge(BubbleableMetadata::createFromRenderArray($build));
        } catch (\Exception $e) {
          throw new EntityNotFoundException(sprintf('Unable to load embedded %s view with %s display.', $view_name, $view_display));
        }
        $this
          ->replaceNodeContent($node, $render_view);
      }
      $result
        ->setProcessedText(Html::serialize($dom));
    }
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public function tips($long = FALSE) {
    if ($long) {
      return $this
        ->t('
        <p>You can embed Views. Additional properties can be added to the embed tag like data-caption and data-align if supported. Example:</p>
        <code><drupal-views data-view-display="default" data-view-name="content"></drupal-views></code>');
    }
    else {
      return $this
        ->t('You can embed Views entities.');
    }
  }

  /**
   * Method that build data attributes per node.
   */
  protected function buildViewsEmbed($node) {
    $view_name = $node
      ->getAttribute('data-view-name');
    $view_display = $node
      ->getAttribute('data-view-display');
    $view_attr = Json::decode($node
      ->getAttribute('data-view-arguments'));
    $view = Views::getView($view_name);
    $view
      ->setDisplay($view_display);
    if ($view_attr['override_title']) {
      $view
        ->setTitle($view_attr['title']);
    }
    if (!empty($view_attr['filters'])) {
      $view_filters = array_filter($view_attr['filters'], function ($k) use ($view_attr) {
        return $view_attr['filters'][$k];
      }, ARRAY_FILTER_USE_KEY);
      $view
        ->setArguments($view_filters);
    }

    // Ensure that views default executions are run. These ensure that view
    // display settings such as "use_ajax" are actually read and respected.
    $view
      ->preExecute();
    $view
      ->execute();
    $build = [
      '#theme_wrappers' => [
        'views_entity_embed_container',
      ],
      '#attributes' => [
        'class' => [
          'views-entity-embed',
        ],
      ],
      '#view' => $view,
      '#context' => [
        'data-view-name' => $view_name,
        'data-view-display' => $view_display,
        'data-override-title' => $view_attr['override_title'],
        'data-title' => $view_attr['title'],
      ],
    ];
    return $build;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FilterBase::$provider public property The name of the provider that owns this filter.
FilterBase::$settings public property An associative array containing the configured settings of this filter.
FilterBase::$status public property A Boolean indicating whether this filter is enabled.
FilterBase::$weight public property The weight of this filter compared to others in a filter collection.
FilterBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 1
FilterBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
FilterBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
FilterBase::getDescription public function Returns the administrative description for this filter plugin. Overrides FilterInterface::getDescription
FilterBase::getHTMLRestrictions public function Returns HTML allowed by this filter's configuration. Overrides FilterInterface::getHTMLRestrictions 4
FilterBase::getLabel public function Returns the administrative label for this filter plugin. Overrides FilterInterface::getLabel
FilterBase::getType public function Returns the processing type of this filter plugin. Overrides FilterInterface::getType
FilterBase::prepare public function Prepares the text for processing. Overrides FilterInterface::prepare
FilterBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration 1
FilterBase::settingsForm public function Generates a filter's settings form. Overrides FilterInterface::settingsForm 3
FilterInterface::TYPE_HTML_RESTRICTOR constant HTML tag and attribute restricting filters to prevent XSS attacks.
FilterInterface::TYPE_MARKUP_LANGUAGE constant Non-HTML markup language filters that generate HTML.
FilterInterface::TYPE_TRANSFORM_IRREVERSIBLE constant Irreversible transformation filters.
FilterInterface::TYPE_TRANSFORM_REVERSIBLE constant Reversible transformation filters.
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.
ViewsEmbedFilter::$renderer protected property The renderer service.
ViewsEmbedFilter::buildViewsEmbed protected function Method that build data attributes per node.
ViewsEmbedFilter::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ViewsEmbedFilter::process public function Performs the filter processing. Overrides FilterInterface::process
ViewsEmbedFilter::tips public function Generates a filter's tip. Overrides FilterBase::tips
ViewsEmbedFilter::__construct public function Constructs a ViewsEmbedFilter object. Overrides FilterBase::__construct