Default style plugin to render an RSS feed.
@Plugin(
id = "rss",
title = @Translation("RSS Feed"),
help = @Translation("Generates an RSS feed from a view."),
theme = "views_view_rss",
display_types = {"feed"}
)
Expanded class hierarchy of Rss
class Rss extends StylePluginBase {
/**
* Does the style plugin for itself support to add fields to it's output.
*
* @var bool
*/
protected $usesRowPlugin = TRUE;
public function attachTo($display_id, $path, $title) {
$display = $this->view->displayHandlers
->get($display_id);
$url_options = array();
$input = $this->view
->getExposedInput();
if ($input) {
$url_options['query'] = $input;
}
$url_options['absolute'] = TRUE;
$url = url($this->view
->getUrl(NULL, $path), $url_options);
if ($display
->hasPath()) {
if (empty($this->preview)) {
drupal_add_feed($url, $title);
}
}
else {
if (empty($this->view->feed_icon)) {
$this->view->feed_icon = '';
}
$feed_icon = array(
'#theme' => 'feed_icon',
'#url' => $url,
'#title' => $title,
);
$this->view->feed_icon .= drupal_render($feed_icon);
drupal_add_html_head_link(array(
'rel' => 'alternate',
'type' => 'application/rss+xml',
'title' => $title,
'href' => $url,
));
}
}
protected function defineOptions() {
$options = parent::defineOptions();
$options['description'] = array(
'default' => '',
'translatable' => TRUE,
);
return $options;
}
public function buildOptionsForm(&$form, &$form_state) {
parent::buildOptionsForm($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().
*/
protected function getChannelElements() {
return array();
}
/**
* Get RSS feed description.
*
* @return string
* The string containing the description with the tokens replaced.
*/
public function getDescription() {
$description = $this->options['description'];
// Allow substitutions from the first row.
$description = $this
->tokenizeValue($description, 0);
return $description;
}
function render() {
if (empty($this->view->rowPlugin)) {
debug('Drupal\\views\\Plugin\\views\\style\\Rss: 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
->getChannelElements();
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->view->rowPlugin
->render($row);
}
$output = theme($this
->themeFunctions(), array(
'view' => $this->view,
'options' => $this->options,
'rows' => $rows,
));
unset($this->view->row_index);
return $output;
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ContainerFactoryPluginBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
11 |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | property | Plugins's definition | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
protected | property | The plugin implementation definition. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function |
Returns the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Adds elements for available core tokens to a form. | |
PluginBase:: |
public | function | Returns a string with any core tokens replaced. | |
PluginBase:: |
public | function | Return the human readable name of the display. | |
PluginBase:: |
protected | function | Fills up the options of the plugin with defaults. | |
PluginBase:: |
public | function | Handle any special handling on the validate form. | 11 |
PluginBase:: |
public | function | Returns the summary of the settings in the display. | 6 |
PluginBase:: |
public | function | Provide a full list of possible theme templates used by this style. | 1 |
PluginBase:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
PluginBase:: |
public | function | Returns the usesOptions property. | 8 |
PluginBase:: |
public | function |
Constructs a Plugin object. Overrides PluginBase:: |
|
Rss:: |
protected | property |
Does the style plugin for itself support to add fields to it's output. Overrides StylePluginBase:: |
|
Rss:: |
public | function | ||
Rss:: |
public | function |
Provide a form to edit options for this plugin. Overrides StylePluginBase:: |
|
Rss:: |
protected | function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides StylePluginBase:: |
|
Rss:: |
protected | function | Return an array of additional XHTML elements to add to the channel. | |
Rss:: |
public | function | Get RSS feed description. | |
Rss:: |
function |
Render the display in this style. Overrides StylePluginBase:: |
||
StylePluginBase:: |
protected | property | The theme function used to render the grouping set. | |
StylePluginBase:: |
protected | property | Stores the rendered field values, keyed by the row index and field name. | |
StylePluginBase:: |
property | Store all available tokens row rows. | ||
StylePluginBase:: |
protected | property | Does the style plugin for itself support to add fields to it's output. | 3 |
StylePluginBase:: |
protected | property | Does the style plugin support grouping of rows. | 3 |
StylePluginBase:: |
protected | property |
Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase:: |
|
StylePluginBase:: |
protected | property | Does the style plugin support custom css class for the rows. | 4 |
StylePluginBase:: |
public | 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 |
StylePluginBase:: |
public | 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 |
StylePluginBase:: |
public | function |
Clears a plugin. Overrides PluginBase:: |
|
StylePluginBase:: |
public | function | Should the output of the style plugin be rendered even if it's a empty view. | 2 |
StylePluginBase:: |
public | function | Gets a rendered field. | |
StylePluginBase:: |
protected | function | Get the raw field value. | |
StylePluginBase:: |
public | function | Return the token replaced row class for the specified row. | |
StylePluginBase:: |
public | function |
Overrides \Drupal\views\Plugin\views\PluginBase::init(). Overrides PluginBase:: |
|
StylePluginBase:: |
function | Allow the style to do stuff before each row is rendered. | ||
StylePluginBase:: |
public | function |
Add anything to the query that we might need to. Overrides PluginBase:: |
1 |
StylePluginBase:: |
protected | function | Renders all of the fields for a given style and store them on the object. | |
StylePluginBase:: |
public | function | Group records as needed for rendering. | |
StylePluginBase:: |
public | function | Render the grouping sets. | |
StylePluginBase:: |
protected | function | Renders a group of rows of the grouped view. | |
StylePluginBase:: |
public | function | Take a value and apply token replacement logic to it. | |
StylePluginBase:: |
function | Return TRUE if this style also uses fields. | 3 | |
StylePluginBase:: |
function | Returns the usesGrouping property. | 3 | |
StylePluginBase:: |
function | Returns the usesRowClass property. | 4 | |
StylePluginBase:: |
function | Returns the usesRowPlugin property. | 8 | |
StylePluginBase:: |
public | function | Return TRUE if this style uses tokens. | |
StylePluginBase:: |
public | function |
Validate that the plugin is correct and can be saved. Overrides PluginBase:: |
|
StylePluginBase:: |
public | function |
Validate the options form. Overrides PluginBase:: |
|
StylePluginBase:: |
public | function | Provide a form in the views wizard if this style is selected. | |
StylePluginBase:: |
public | function | Alter the options of a display before they are added to the view. | 1 |