class Rss

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

Plugin which formats the comments as RSS items.

Plugin annotation


@ViewsRow(
  id = "comment_rss",
  title = @Translation("Comment"),
  help = @Translation("Display the comment as RSS."),
  theme = "views_view_row_rss",
  register_theme = FALSE,
  base = {"comment_field_data"},
  display_types = {"feed"}
)

Hierarchy

Expanded class hierarchy of Rss

41 string references to 'Rss'
AggregatorRenderingTest::testFeedPage in core/modules/aggregator/tests/src/Functional/AggregatorRenderingTest.php
Creates a feed and checks that feed's page.
book_node_links_alter in core/modules/book/book.module
Implements hook_node_links_alter().
CommentLinkBuilder::buildCommentedEntityLinks in core/modules/comment/src/CommentLinkBuilder.php
CommentLinkBuilderTest::getLinkCombinations in core/modules/comment/tests/src/Unit/CommentLinkBuilderTest.php
Data provider for ::testCommentLinkBuilder.
comment_entity_view in core/modules/comment/comment.module
Implements hook_entity_view().

... See full list

File

core/modules/comment/src/Plugin/views/row/Rss.php, line 20

Namespace

Drupal\comment\Plugin\views\row
View source
class Rss extends RssPluginBase {
  
  /**
   * {@inheritdoc}
   */
  protected $base_table = 'comment_field_data';
  
  /**
   * {@inheritdoc}
   */
  protected $base_field = 'cid';
  
  /**
   * @var \Drupal\comment\CommentInterface[]
   */
  protected $comments;
  
  /**
   * {@inheritdoc}
   */
  protected $entityTypeId = 'comment';
  public function preRender($result) {
    $cids = [];
    foreach ($result as $row) {
      $cids[] = $row->cid;
    }
    $this->comments = $this->entityTypeManager
      ->getStorage('comment')
      ->loadMultiple($cids);
  }
  
  /**
   * {@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;
  }
  public function render($row) {
    global $base_url;
    $cid = $row->{$this->field_alias};
    if (!is_numeric($cid)) {
      return;
    }
    $view_mode = $this->options['view_mode'];
    if ($view_mode == 'default') {
      $view_mode = \Drupal::config('system.rss')->get('items.view_mode');
    }
    // Load the specified comment and its associated node:
    /** @var \Drupal\comment\CommentInterface $comment */
    $comment = $this->comments[$cid];
    if (empty($comment)) {
      return;
    }
    $comment->rss_namespaces = [];
    $comment->rss_elements = [
      [
        'key' => 'pubDate',
        'value' => gmdate('r', $comment->getCreatedTime()),
      ],
      [
        'key' => 'dc:creator',
        'value' => $comment->getAuthorName(),
      ],
      [
        'key' => 'guid',
        'value' => 'comment ' . $comment->id() . ' at ' . $base_url,
        'attributes' => [
          'isPermaLink' => 'false',
        ],
      ],
    ];
    // The comment gets built and modules add to or modify
    // $comment->rss_elements and $comment->rss_namespaces.
    $build = $this->entityTypeManager
      ->getViewBuilder('comment')
      ->view($comment, 'rss');
    unset($build['#theme']);
    if (!empty($comment->rss_namespaces)) {
      $this->view->style_plugin->namespaces = array_merge($this->view->style_plugin->namespaces, $comment->rss_namespaces);
    }
    $item = new \stdClass();
    if ($view_mode != 'title') {
      // We render comment contents.
      $item->description = $build;
    }
    $item->title = $comment->label();
    $item->link = $comment->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 =& $comment->rss_elements;
    $item->cid = $comment->id();
    $build = [
      '#theme' => $this->themeFunctions(),
      '#view' => $this->view,
      '#options' => $this->options,
      '#row' => $item,
    ];
    return $build;
  }

}

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