class views_plugin_style_rss

  1. 3.x plugins/views_plugin_style_rss.inc views_plugin_style_rss
  2. 2.x plugins/views_plugin_style_rss.inc views_plugin_style_rss

Default style plugin to render an RSS feed.

Hierarchy

Expanded class hierarchy of views_plugin_style_rss

Related topics

Views' style plugins
Style plugins control how a view is rendered. For example, they can choose to display a collection of fields, node_view() output, table output, or any kind of crazy output they want.
1 string reference to 'views_plugin_style_rss'
views_views_plugins in includes/plugins.inc
Implementation of hook_views_plugins

File

plugins/views_plugin_style_rss.inc, line 12
Contains the RSS style plugin.

View source
class views_plugin_style_rss extends views_plugin_style {
  function attach_to($display_id, $path, $title) {
    $display = $this->view->display[$display_id]->handler;
    $url_options = array();
    $input = $this->view->get_exposed_input();
    if ($input) {
      $url_options['query'] = $input;
    }

    $url = url($this->view->get_url(NULL, $path), $url_options);
    if ($display->has_path()) {
      if (empty($this->preview)) {
        drupal_add_feed($url, $title);
      }
    }
    else {
      if (empty($this->view->feed_icon)) {
        $this->view->feed_icon = '';
      }

      $this->view->feed_icon .= theme('feed_icon', $url, $title);
      drupal_add_link(array(
        'rel' => 'alternate',
        'type' => 'application/rss+xml',
        'title' => $title,
        'href' => $url
      ));
    }
  }

  function option_definition() {
    $options = parent::option_definition();

    $options['description'] = array('default' => '', 'translatable' => TRUE);
    $options['mission_description'] = array('default' => '', 'translatable' => TRUE);

    return $options;
  }

  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);

    $form['mission_description'] = array(
      '#type' => 'checkbox',
      '#default_value' => !empty($this->options['mission_description']),
      '#title' => t('Use the site mission for the description'),
    );
    $form['description'] = array(
      '#type' => 'textfield',
      '#title' => t('RSS description'),
      '#default_value' => $this->options['description'],
      '#description' => t('This will appear in the RSS feed itself.'),
      '#process' => array('views_process_dependency'),
      '#dependency' => array('edit-style-options-override' => array(FALSE)),
    );
  }

  /**
   * Return an array of additional XHTML elements to add to the channel.
   *
   * @return
   *   An array that can be passed to format_xml_elements().
   */
  function get_channel_elements() {
    return array();
  }

  function render() {
    if (empty($this->row_plugin)) {
      vpr('views_plugin_style_default: Missing row plugin');
      return;
    }
    $rows = '';

    // This will be filled in by the row plugin and is used later on in the
    // theming output.
    $this->namespaces = array();

    // Fetch any additional elements for the channel and merge in their
    // namespaces.
    $this->channel_elements = $this->get_channel_elements();
    foreach ($this->channel_elements as $element) {
      if (isset($element['namespace'])) {
        $this->namespaces = array_merge($this->namespaces, $element['namespace']);
      }
    }

    foreach ($this->view->result as $row_index => $row) {
      $this->view->row_index = $row_index;
      $rows .= $this->row_plugin->render($row);
    }

    $output = theme($this->theme_functions(), $this->view, $this->options, $rows);
    unset($this->view->row_index);

    return $output;
  }
}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
views_object::construct function Views handlers use a special construct function so that we can more easily construct them with variable arguments.
views_object::options function Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.
views_object::set_default_options function Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point.
views_object::set_definition function Let the handler know what its full definition is.
views_object::unpack_options function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::_set_option_defaults function
views_plugin::additional_theme_functions function Provide a list of additional theme functions for the theme information page
views_plugin::options_submit function Handle any special handling on the validate form.
views_plugin::options_validate function Validate the options form.
views_plugin::theme_functions function Provide a full list of possible theme templates used by this style.
views_plugin_style::build_sort function Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query.
views_plugin_style::build_sort_post function Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view.
views_plugin_style::destroy function Overrides views_object::destroy
views_plugin_style::get_field function Get a rendered field.
views_plugin_style::init function Initialize a style plugin. Overrides views_plugin::init
views_plugin_style::pre_render function Allow the style to do stuff before each row is rendered.
views_plugin_style::query function Add anything to the query that we might need to. Overrides views_plugin::query
views_plugin_style::render_fields function Render all of the fields for a given style and store them on the object.
views_plugin_style::render_grouping function Group records as needed for rendering.
views_plugin_style::uses_fields function Return TRUE if this style also uses fields.
views_plugin_style::uses_row_plugin function Return TRUE if this style also uses a row plugin.
views_plugin_style::validate function Validate that the plugin is correct and can be saved. Overrides views_plugin::validate
views_plugin_style_rss::attach_to function
views_plugin_style_rss::get_channel_elements function Return an array of additional XHTML elements to add to the channel.
views_plugin_style_rss::options_form function Provide a form to edit options for this plugin. Overrides views_plugin_style::options_form
views_plugin_style_rss::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_plugin_style::option_definition
views_plugin_style_rss::render function Render the display in this style. Overrides views_plugin_style::render