class views_plugin_style_rss
- 3.x plugins/views_plugin_style_rss.inc views_plugin_style_rss
- 2.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
- class \views_plugin_style
- class \views_plugin_style_rss
- class \views_plugin_style
- class \views_plugin
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 - Implements hook_views_plugins().
File
- plugins/
views_plugin_style_rss.inc, line 13 - 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_options['absolute'] = TRUE;
$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', array('url' => $url, 'title' => $title));
drupal_add_html_head_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);
return $options;
}
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form['description'] = array(
'#type' => 'textfield',
'#title' => t('RSS description'),
'#default_value' => $this->options['description'],
'#description' => t('This will appear in the RSS feed itself.'),
'#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('xmlns:dc' => 'http://purl.org/dc/elements/1.1/');
// 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(),
array(
'view' => $this->view,
'options' => $this->options,
'rows' => $rows
));
unset($this->view->row_index);
return $output;
}
}
Members
Name | Modifiers | Type | Description |
---|---|---|---|
views_object:: |
function | Views handlers use a special construct function so that we can more easily construct them with variable arguments. | |
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | Always exports the option, regardless of the default value. | |
views_object:: |
function | Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. | |
views_object:: |
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:: |
function | Let the handler know what its full definition is. | |
views_object:: |
function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
function | Unpack a single option definition. | |
views_object:: |
function | Unpacks each handler to store translatable texts. | |
views_object:: |
function | ||
views_plugin:: |
function | Provide a list of additional theme functions for the theme information page | |
views_plugin:: |
function | Handle any special handling on the validate form. | |
views_plugin:: |
function | Return the human readable name of the display. | |
views_plugin:: |
function | Returns the summary of the settings in the display. | |
views_plugin:: |
function | Provide a full list of possible theme templates used by this style. | |
views_plugin_style:: |
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:: |
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:: |
function |
Overrides views_object:: |
|
views_plugin_style:: |
function | Should the output of the style plugin be rendered even if it's a empty view. | |
views_plugin_style:: |
function | Get a rendered field. | |
views_plugin_style:: |
function | Get the raw field value. | |
views_plugin_style:: |
function | Return the token replaced row class for the specified row. | |
views_plugin_style:: |
function | Initialize a style plugin. | |
views_plugin_style:: |
function |
Validate the options form. Overrides views_plugin:: |
|
views_plugin_style:: |
function | Allow the style to do stuff before each row is rendered. | |
views_plugin_style:: |
function |
Add anything to the query that we might need to. Overrides views_plugin:: |
|
views_plugin_style:: |
function | Render all of the fields for a given style and store them on the object. | |
views_plugin_style:: |
function | Group records as needed for rendering. | |
views_plugin_style:: |
function | Render the grouping sets. | |
views_plugin_style:: |
function | Take a value and apply token replacement logic to it. | |
views_plugin_style:: |
function | Return TRUE if this style also uses fields. | |
views_plugin_style:: |
function | Return TRUE if this style also uses a row plugin. | |
views_plugin_style:: |
function | Return TRUE if this style also uses a row plugin. | |
views_plugin_style:: |
function | Return TRUE if this style uses tokens. | |
views_plugin_style:: |
function |
Validate that the plugin is correct and can be saved. Overrides views_plugin:: |
|
views_plugin_style_rss:: |
function | ||
views_plugin_style_rss:: |
function | Return an array of additional XHTML elements to add to the channel. | |
views_plugin_style_rss:: |
function | Get RSS feed description. | |
views_plugin_style_rss:: |
function |
Provide a form to edit options for this plugin. Overrides views_plugin_style:: |
|
views_plugin_style_rss:: |
function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides views_plugin_style:: |
|
views_plugin_style_rss:: |
function |
Render the display in this style. Overrides views_plugin_style:: |