class Rss in Views (for Drupal 7) 8.3

Plugin which formats the comments as RSS items.

Plugin annotation

@Plugin(
  id = "comment_rss",
  module = "comment",
  title = @Translation("Comment"),
  help = @Translation("Display the comment as RSS."),
  theme = "views_view_row_rss",
  base = {"comment"},
  type = "feed"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\views\Plugin\views\PluginBase
    • class \Drupal\views\Plugin\views\row\RowPluginBase
      • class \Views\comment\Plugin\views\row\Rss

File

lib/Views/comment/Plugin/views/row/Rss.php, line 27

Definition of Views\comment\Plugin\views\row\Rss.

Namespace

Views\comment\Plugin\views\row

class Rss extends RowPluginBase {
  var $base_table = 'comment';
  var $base_field = 'cid';
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['item_length'] = array(
      'default' => 'default',
    );
    $options['links'] = array(
      'default' => FALSE,
      'bool' => TRUE,
    );
    return $options;
  }
  public function buildOptionsForm(&$form, &$form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['item_length'] = array(
      '#type' => 'select',
      '#title' => t('Display type'),
      '#options' => $this
        ->options_form_summary_options(),
      '#default_value' => $this->options['item_length'],
    );
    $form['links'] = array(
      '#type' => 'checkbox',
      '#title' => t('Display links'),
      '#default_value' => $this->options['links'],
    );
  }
  function pre_render($result) {
    $cids = array();
    $nids = array();
    foreach ($result as $row) {
      $cids[] = $row->cid;
    }
    $this->comments = comment_load_multiple($cids);
    foreach ($this->comments as &$comment) {
      $comment->depth = count(explode('.', $comment->thread)) - 1;
      $nids[] = $comment->nid;
    }
    $this->nodes = node_load_multiple($nids);
  }

  /**
   * Return the main options, which are shown in the summary title
   *
   * @see views_plugin_row_node_rss::options_form_summary_options()
   * @todo: Maybe provide a views_plugin_row_rss_entity and reuse this method
   * in views_plugin_row_comment|node_rss.inc
   */
  function options_form_summary_options() {
    $entity_info = entity_get_info('node');
    $options = array();
    if (!empty($entity_info['view modes'])) {
      foreach ($entity_info['view modes'] as $mode => $settings) {
        $options[$mode] = $settings['label'];
      }
    }
    $options['title'] = t('Title only');
    $options['default'] = t('Use site default RSS settings');
    return $options;
  }
  function render($row) {
    global $base_url;
    $cid = $row->{$this->field_alias};
    if (!is_numeric($cid)) {
      return;
    }
    $item_length = $this->options['item_length'];
    if ($item_length == 'default') {
      $item_length = config('system.rss')
        ->get('items.view_mode');
    }

    // Load the specified comment and its associated node:
    $comment = $this->comments[$cid];
    if (empty($comment) || empty($this->nodes[$comment->nid])) {
      return;
    }
    $item_text = '';
    $uri = $comment
      ->uri();
    $comment->link = url($uri['path'], $uri['options'] + array(
      'absolute' => TRUE,
    ));
    $comment->rss_namespaces = array();
    $comment->rss_elements = array(
      array(
        'key' => 'pubDate',
        'value' => gmdate('r', $comment->created),
      ),
      array(
        'key' => 'dc:creator',
        'value' => $comment->name,
      ),
      array(
        'key' => 'guid',
        'value' => 'comment ' . $comment
          ->id() . ' at ' . $base_url,
        'attributes' => array(
          'isPermaLink' => 'false',
        ),
      ),
    );

    // The comment gets built and modules add to or modify
    // $comment->rss_elements and $comment->rss_namespaces.
    $build = comment_view($comment, $this->nodes[$comment->nid], 'rss');
    unset($build['#theme']);
    if (!empty($comment->rss_namespaces)) {
      $this->view->style_plugin->namespaces = array_merge($this->view->style_plugin->namespaces, $comment->rss_namespaces);
    }

    // Hide the links if desired.
    if (!$this->options['links']) {
      hide($build['links']);
    }
    if ($item_length != 'title') {

      // We render comment contents and force links to be last.
      $build['links']['#weight'] = 1000;
      $item_text .= drupal_render($build);
    }
    $item = new stdClass();
    $item->description = $item_text;
    $item->title = $comment
      ->label();
    $item->link = $comment->link;
    $item->elements = $comment->rss_elements;
    $item->cid = $comment
      ->id();
    return theme($this
      ->themeFunctions(), array(
      'view' => $this->view,
      'options' => $this->options,
      'row' => $item,
    ));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$definition	public	property	Plugins's definition
PluginBase::$displayHandler	public	property	The display object this plugin is for.
PluginBase::$options	public	property	Options for this plugin will be held here.
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::$view	public	property	The top object of a view.	1
PluginBase::additionalThemeFunctions	public	function	Provide a list of additional theme functions for the theme information page
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy	public	function	Clears a plugin.	2
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	3
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.
PluginBase::pluginTitle	public	function	Return the human readable name of the display.
PluginBase::setOptionDefaults	protected	function
PluginBase::summaryTitle	public	function	Returns the summary of the settings in the display.	6
PluginBase::themeFunctions	public	function	Provide a full list of possible theme templates used by this style.	1
PluginBase::unpackOptions	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions	public	function	Returns the usesOptions property.	8
PluginBase::validate	public	function	Validate that the plugin is correct and can be saved.	4
PluginBase::__construct	public	function	Constructs a Plugin object. Overrides PluginBase::__construct	2
RowPluginBase::$usesFields	protected	property	Does the row plugin support to add fields to it's output.	2
RowPluginBase::$usesOptions	protected	property	Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase::$usesOptions
RowPluginBase::init	public	function	Initialize the row plugin.	1
RowPluginBase::query	public	function	Add anything to the query that we might need to. Overrides PluginBase::query
RowPluginBase::submitOptionsForm	public	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. Overrides PluginBase::submitOptionsForm	1
RowPluginBase::usesFields		function	Returns the usesFields property.	2
RowPluginBase::validateOptionsForm	public	function	Validate the options form. Overrides PluginBase::validateOptionsForm
Rss::$base_field		property
Rss::$base_table		property
Rss::buildOptionsForm	public	function	Provide a form for setting options. Overrides RowPluginBase::buildOptionsForm
Rss::defineOptions	protected	function	Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides RowPluginBase::defineOptions
Rss::options_form_summary_options		function	Return the main options, which are shown in the summary title
Rss::pre_render		function	Allow the style to do stuff before each row is rendered. Overrides RowPluginBase::pre_render
Rss::render		function	Render a row object. This usually passes through to a theme template of some form, but not always. Overrides RowPluginBase::render