class views_plugin_style_rss
Same name in other branches
- 7.x-3.x plugins/views_plugin_style_rss.inc \views_plugin_style_rss
Default style plugin to render an RSS feed.
Hierarchy
- class \views_object
- class \views_plugin extends \views_object
- class \views_plugin_style extends \views_plugin
- class \views_plugin_style_rss extends \views_plugin_style
- class \views_plugin_style extends \views_plugin
- class \views_plugin extends \views_object
Expanded class hierarchy of views_plugin_style_rss
Related topics
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
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,
),
),
'#maxlength' => 1024,
);
}
/**
* 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();
}
/**
* Get RSS feed description.
*
* @return string
* The string containing the description with the tokens replaced.
*/
function get_description() {
$description = $this->options['description'];
// Allow substitutions from the first row.
$description = $this->tokenize_value($description, 0);
return $description;
}
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
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
views_object::$definition | property | Handler's definition | |||
views_object::$options | property | Except for displays, options for the object will be held here. | 1 | ||
views_object::construct | function | Views handlers use a special construct function so that we can more easily construct them with variable arguments. |
6 | ||
views_object::export_option | function | 1 | |||
views_object::export_options | function | ||||
views_object::options | function | Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. |
1 | ||
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::unpack_translatable | function | Unpack a single option definition. | |||
views_object::unpack_translatables | function | Unpacks each handler to store translatable texts. | |||
views_object::_set_option_defaults | function | ||||
views_plugin::$display | property | The current used views display. | |||
views_plugin::$plugin_type | property | The plugin type of this plugin, for example style or query. | |||
views_plugin::$view | property | The top object of a view. | Overrides views_object::$view | 1 | |
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. | 9 | ||
views_plugin::options_validate | function | Validate the options form. | 8 | ||
views_plugin::theme_functions | function | Provide a full list of possible theme templates used by this style. | |||
views_plugin_style::$row_plugin | property | Contains the row plugin, if it's initialized and the style itself supports it. |
|||
views_plugin_style::$row_tokens | property | Store all availible tokens row rows. | |||
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. |
1 | ||
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. |
1 | ||
views_plugin_style::destroy | function | Overrides views_object::destroy | |||
views_plugin_style::even_empty | function | Should the output of the style plugin be rendered even if it's a empty view. | 1 | ||
views_plugin_style::get_field | function | Get a rendered field. | |||
views_plugin_style::get_row_class | function | Return the token replaced row class for the specified row. | |||
views_plugin_style::init | function | Initialize a style plugin. | |||
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 | 2 | |
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::tokenize_value | function | Take a value and apply token replacement logic to it. | |||
views_plugin_style::uses_fields | function | Return TRUE if this style also uses fields. | |||
views_plugin_style::uses_row_class | function | Return TRUE if this style also uses a row plugin. | |||
views_plugin_style::uses_row_plugin | function | Return TRUE if this style also uses a row plugin. | |||
views_plugin_style::uses_tokens | function | Return TRUE if this style uses tokens. | |||
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::get_description | function | Get RSS feed description. | |||
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 |