Rss.php

Same filename in this branch
  1. 11.x core/modules/views/src/Plugin/views/style/Rss.php
  2. 11.x core/modules/comment/src/Plugin/views/row/Rss.php
Same filename and directory in other branches
  1. 9 core/modules/node/src/Plugin/views/row/Rss.php
  2. 9 core/modules/views/src/Plugin/views/style/Rss.php
  3. 9 core/modules/aggregator/src/Plugin/views/row/Rss.php
  4. 9 core/modules/comment/src/Plugin/views/row/Rss.php
  5. 8.9.x core/modules/node/src/Plugin/views/row/Rss.php
  6. 8.9.x core/modules/views/src/Plugin/views/style/Rss.php
  7. 8.9.x core/modules/aggregator/src/Plugin/views/row/Rss.php
  8. 8.9.x core/modules/comment/src/Plugin/views/row/Rss.php
  9. 10 core/modules/node/src/Plugin/views/row/Rss.php
  10. 10 core/modules/views/src/Plugin/views/style/Rss.php
  11. 10 core/modules/comment/src/Plugin/views/row/Rss.php

Namespace

Drupal\node\Plugin\views\row

File

core/modules/node/src/Plugin/views/row/Rss.php

View source
<?php

namespace Drupal\node\Plugin\views\row;

use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\views\Attribute\ViewsRow;
use Drupal\views\Plugin\views\row\RssPluginBase;

/**
 * Performs a node_view on the resulting object and formats it as an RSS item.
 */
class Rss extends RssPluginBase {
  
  /**
   * The base table for this row plugin.
   *
   * @var string
   */
  // phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName, Drupal.Commenting.VariableComment.Missing
  public $base_table = 'node_field_data';
  
  /**
   * The base field for this row plugin.
   */
  // phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName, Drupal.Commenting.VariableComment.Missing
  public string $base_field = 'nid';
  
  /**
   * Stores the nodes loaded with preRender.
   *
   * @var array
   */
  public $nodes = [];
  
  /**
   * {@inheritdoc}
   */
  protected $entityTypeId = 'node';
  
  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm_summary_options() {
    $options = parent::buildOptionsForm_summary_options();
    $options['title'] = $this->t('Title only');
    $options['default'] = $this->t('Use site default RSS settings');
    return $options;
  }
  
  /**
   * {@inheritdoc}
   */
  public function summaryTitle() {
    $options = $this->buildOptionsForm_summary_options();
    return $options[$this->options['view_mode']];
  }
  
  /**
   * {@inheritdoc}
   */
  public function preRender($values) {
    $nids = [];
    foreach ($values as $row) {
      $nids[] = $row->{$this->field_alias};
    }
    if (!empty($nids)) {
      $this->nodes = $this->entityTypeManager
        ->getStorage('node')
        ->loadMultiple($nids);
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public function render($row) {
    global $base_url;
    $nid = $row->{$this->field_alias};
    if (!is_numeric($nid)) {
      return;
    }
    $display_mode = $this->options['view_mode'];
    if ($display_mode == 'default') {
      $display_mode = \Drupal::config('system.rss')->get('items.view_mode');
    }
    // Load the specified node:
    /** @var \Drupal\node\NodeInterface $node */
    $node = $this->nodes[$nid];
    if (empty($node)) {
      return;
    }
    $node->rss_namespaces = [];
    $node->rss_elements = [
      [
        'key' => 'pubDate',
        'value' => gmdate('r', $node->getCreatedTime()),
      ],
      [
        'key' => 'dc:creator',
        'value' => $node->getOwner()
          ->getDisplayName(),
      ],
      [
        'key' => 'guid',
        'value' => $node->id() . ' at ' . $base_url,
        'attributes' => [
          'isPermaLink' => 'false',
        ],
      ],
    ];
    // The node gets built and modules add to or modify $node->rss_elements
    // and $node->rss_namespaces.
    $build_mode = $display_mode;
    $build = \Drupal::entityTypeManager()->getViewBuilder('node')
      ->view($node, $build_mode);
    // Add rss key to cache to differentiate this from other caches.
    $build['#cache']['keys'][] = 'view_rss';
    unset($build['#theme']);
    if (!empty($node->rss_namespaces)) {
      $this->view->style_plugin->namespaces = array_merge($this->view->style_plugin->namespaces, $node->rss_namespaces);
    }
    $item = new \stdClass();
    if ($display_mode != 'title') {
      // We render node contents.
      $item->description = $build;
    }
    $item->title = $node->label();
    $item->link = $node->toUrl('canonical', [
      'absolute' => TRUE,
    ])
      ->toString();
    // Provide a reference so that the render call in
    // template_preprocess_views_view_row_rss() can still access it.
    $item->elements =& $node->rss_elements;
    $item->nid = $node->id();
    $build = [
      '#theme' => $this->themeFunctions(),
      '#view' => $this->view,
      '#options' => $this->options,
      '#row' => $item,
    ];
    return $build;
  }

}

Classes

Title Deprecated Summary
Rss Performs a node_view on the resulting object and formats it as an RSS item.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.