class Rss

Same name in this branch

Plugin which performs a node_view on the resulting object and formats it as an RSS item.

Plugin annotation


@Plugin(
  id = "node_rss",
  title = @Translation("Content"),
  help = @Translation("Display the content with standard node view."),
  theme = "views_view_row_rss",
  base = {"node"},
  type = "feed",
  module = "node"
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements PluginInspectionInterface
- class \Drupal\views\Plugin\views\PluginBase
  - class \Drupal\views\Plugin\views\row\RowPluginBase
    class \Drupal\node\Plugin\views\row\Rss

Expanded class hierarchy of Rss

File

drupal/core/modules/node/lib/Drupal/node/Plugin/views/row/Rss.php, line 28: Definition of Drupal\node\Plugin\views\row\Rss.

Namespace

Drupal\node\Plugin\views\row

View source

class Rss extends RowPluginBase {

  // Basic properties that let the row style follow relationships.
  var $base_table = 'node';
  var $base_field = 'nid';

  // Stores the nodes loaded with pre_render.
  var $nodes = array();
  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
        ->buildOptionsForm_summary_options(),
      '#default_value' => $this->options['item_length'],
    );
    $form['links'] = array(
      '#type' => 'checkbox',
      '#title' => t('Display links'),
      '#default_value' => $this->options['links'],
    );
  }

  /**
   * Return the main options, which are shown in the summary title.
   */
  public function buildOptionsForm_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;
  }
  public function summaryTitle() {
    $options = $this
      ->buildOptionsForm_summary_options();
    return check_plain($options[$this->options['item_length']]);
  }
  function pre_render($values) {
    $nids = array();
    foreach ($values as $row) {
      $nids[] = $row->{$this->field_alias};
    }
    if (!empty($nids)) {
      $this->nodes = node_load_multiple($nids);
    }
  }
  function render($row) {

    // For the most part, this code is taken from node_feed() in node.module
    global $base_url;
    $nid = $row->{$this->field_alias};
    if (!is_numeric($nid)) {
      return;
    }
    $display_mode = $this->options['item_length'];
    if ($display_mode == 'default') {
      $display_mode = config('system.rss')
        ->get('items.view_mode');
    }

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

    // The node gets built and modules add to or modify $node->rss_elements
    // and $node->rss_namespaces.
    $build_mode = $display_mode;
    $build = node_view($node, $build_mode);
    unset($build['#theme']);
    if (!empty($node->rss_namespaces)) {
      $this->view->style_plugin->namespaces = array_merge($this->view->style_plugin->namespaces, $node->rss_namespaces);
    }
    elseif (function_exists('rdf_get_namespaces')) {

      // Merge RDF namespaces in the XML namespaces in case they are used
      // further in the RSS content.
      $xml_rdf_namespaces = array();
      foreach (rdf_get_namespaces() as $prefix => $uri) {
        $xml_rdf_namespaces['xmlns:' . $prefix] = $uri;
      }
      $this->view->style_plugin->namespaces += $xml_rdf_namespaces;
    }

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

      // We render node 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 = $node
      ->label();
    $item->link = $node->link;
    $item->elements = $node->rss_elements;
    $item->nid = $node->nid;
    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::$discovery	protected	property	The discovery object.
PluginBase::$displayHandler	public	property	The display object this plugin is for.
PluginBase::$options	public	property	Options for this plugin will be held here.
PluginBase::$plugin_id	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::destroy	public	function	Clears a plugin.	2
PluginBase::getAvailableGlobalTokens	public	function	Returns an array of available token replacements.
PluginBase::getDefinition	public	function	Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface::getDefinition
PluginBase::getPluginId	public	function	Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface::getPluginId
PluginBase::globalTokenForm	public	function	Adds elements for available core tokens to a form.
PluginBase::globalTokenReplace	public	function	Returns a string with any core tokens replaced.
PluginBase::pluginTitle	public	function	Return the human readable name of the display.
PluginBase::setOptionDefaults	protected	function
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
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::$nodes		property
Rss::buildOptionsForm	public	function	Provide a form for setting options. Overrides RowPluginBase::buildOptionsForm
Rss::buildOptionsForm_summary_options	public	function	Return the main options, which are shown in the summary title.
Rss::defineOptions	protected	function	Information about options for all kinds of purposes will be held here. @code 'option_name' => array( Overrides RowPluginBase::defineOptions
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
Rss::summaryTitle	public	function	Returns the summary of the settings in the display. Overrides PluginBase::summaryTitle

Main menu

Search Drupal 9.x

API Navigation

class Rss

Plugin annotation

Hierarchy

File

Namespace

Members

Main menu

You are here

Search Drupal 9.x

API Navigation

class Rss

Plugin annotation

Hierarchy

File

Namespace

Members