The plugin that handles a feed, such as RSS or atom.
@Plugin(
id = "feed",
title = @Translation("Feed"),
help = @Translation("Display the view as a feed, such as an RSS feed."),
uses_hook_menu = TRUE,
admin = @Translation("Feed")
)
Expanded class hierarchy of Feed
class Feed extends PathPluginBase {
/**
* Whether the display allows the use of AJAX or not.
*
* @var bool
*/
protected $usesAJAX = FALSE;
/**
* Whether the display allows the use of a pager or not.
*
* @var bool
*/
protected $usesPager = FALSE;
public function init(ViewExecutable $view, &$display, $options = NULL) {
parent::init($view, $display, $options);
// Set the default row style. Ideally this would be part of the option
// definition, but in this case it's dependent on the view's base table,
// which we don't know until init().
$row_plugins = views_fetch_plugin_names('row', $this
->getStyleType(), array(
$view->storage
->get('base_table'),
));
$default_row_plugin = key($row_plugins);
if (empty($this->options['row']['type'])) {
$this->options['row']['type'] = $default_row_plugin;
}
}
/**
* Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::getStyleType().
*/
protected function getStyleType() {
return 'feed';
}
/**
* Overrides \Drupal\views\Plugin\views\display\PathPluginBase::execute().
*/
public function execute() {
parent::execute();
$output = $this->view
->render();
if (empty($output)) {
throw new NotFoundHttpException();
}
$response = $this->view
->getResponse();
$response
->setContent($output);
return $response;
}
/**
* Overrides \Drupal\views\Plugin\views\display\PathPluginBase::preview().
*/
public function preview() {
if (!empty($this->view->live_preview)) {
return '<pre>' . check_plain($this->view
->render()) . '</pre>';
}
return $this->view
->render();
}
/**
* Overrides \Drupal\views\Plugin\views\display\PathPluginBase::render().
*/
public function render() {
return $this->view->style_plugin
->render($this->view->result);
}
/**
* Overrides \Drupal\views\Plugin\views\displays\DisplayPluginBase::defaultableSections().
*/
public function defaultableSections($section = NULL) {
$sections = parent::defaultableSections($section);
if (in_array($section, array(
'style',
'row',
))) {
return FALSE;
}
// Tell views our sitename_title option belongs in the title section.
if ($section == 'title') {
$sections[] = 'sitename_title';
}
elseif (!$section) {
$sections['title'][] = 'sitename_title';
}
return $sections;
}
/**
* Overrides \Drupal\views\Plugin\views\display\PathPluginBase::defineOptions().
*/
protected function defineOptions() {
$options = parent::defineOptions();
$options['displays'] = array(
'default' => array(),
);
// Overrides for standard stuff:
$options['style']['contains']['type']['default'] = 'rss';
$options['style']['contains']['options']['default'] = array(
'description' => '',
);
$options['sitename_title']['default'] = FALSE;
$options['row']['contains']['type']['default'] = '';
$options['defaults']['default']['style'] = FALSE;
$options['defaults']['default']['row'] = FALSE;
return $options;
}
/**
* Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::optionsSummary().
*/
public function optionsSummary(&$categories, &$options) {
parent::optionsSummary($categories, $options);
// Since we're childing off the 'path' type, we'll still *call* our
// category 'page' but let's override it so it says feed settings.
$categories['page'] = array(
'title' => t('Feed settings'),
'column' => 'second',
'build' => array(
'#weight' => -10,
),
);
if ($this
->getOption('sitename_title')) {
$options['title']['value'] = t('Using the site name');
}
$displays = array_filter($this
->getOption('displays'));
if (count($displays) > 1) {
$attach_to = t('Multiple displays');
}
elseif (count($displays) == 1) {
$display = array_shift($displays);
$displays = $this->view->storage
->get('display');
if (!empty($displays[$display])) {
$attach_to = check_plain($displays[$display]['display_title']);
}
}
if (!isset($attach_to)) {
$attach_to = t('None');
}
$options['displays'] = array(
'category' => 'page',
'title' => t('Attach to'),
'value' => $attach_to,
);
}
/**
* Overrides \Drupal\views\Plugin\views\display\PathPluginBase::buildOptionsForm().
*/
public function buildOptionsForm(&$form, &$form_state) {
// It is very important to call the parent function here.
parent::buildOptionsForm($form, $form_state);
switch ($form_state['section']) {
case 'title':
$title = $form['title'];
// A little juggling to move the 'title' field beyond our checkbox.
unset($form['title']);
$form['sitename_title'] = array(
'#type' => 'checkbox',
'#title' => t('Use the site name for the title'),
'#default_value' => $this
->getOption('sitename_title'),
);
$form['title'] = $title;
$form['title']['#states'] = array(
'visible' => array(
':input[name="sitename_title"]' => array(
'checked' => FALSE,
),
),
);
break;
case 'displays':
$form['#title'] .= t('Attach to');
$displays = array();
foreach ($this->view->storage
->get('display') as $display_id => $display) {
// @todo The display plugin should have display_title and id as well.
if (!empty($this->view->displayHandlers[$display_id]) && $this->view->displayHandlers[$display_id]
->acceptAttachments()) {
$displays[$display_id] = $display['display_title'];
}
}
$form['displays'] = array(
'#type' => 'checkboxes',
'#description' => t('The feed icon will be available only to the selected displays.'),
'#options' => $displays,
'#default_value' => $this
->getOption('displays'),
);
break;
case 'path':
$form['path']['#description'] = t('This view will be displayed by visiting this path on your site. It is recommended that the path be something like "path/%/%/feed" or "path/%/%/rss.xml", putting one % in the path for each contextual filter you have defined in the view.');
}
}
/**
* Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::submitOptionsForm().
*/
public function submitOptionsForm(&$form, &$form_state) {
parent::submitOptionsForm($form, $form_state);
switch ($form_state['section']) {
case 'title':
$this
->setOption('sitename_title', $form_state['values']['sitename_title']);
break;
case 'displays':
$this
->setOption($form_state['section'], $form_state['values'][$form_state['section']]);
break;
}
}
/**
* Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::attachTo().
*/
public function attachTo($display_id) {
$displays = $this
->getOption('displays');
if (empty($displays[$display_id])) {
return;
}
// Defer to the feed style; it may put in meta information, and/or
// attach a feed icon.
$plugin = $this
->getPlugin('style');
if ($plugin) {
$clone = $this->view
->cloneView();
$clone
->setDisplay($this->display['id']);
$clone
->buildTitle();
$plugin
->attach_to($display_id, $this
->getPath(), $clone
->getTitle());
// Clean up
$clone
->destroy();
unset($clone);
}
}
/**
* Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::usesLinkDisplay().
*/
public function usesLinkDisplay() {
return TRUE;
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DisplayPluginBase:: |
property | Stores all available display extenders. | ||
DisplayPluginBase:: |
property | |||
DisplayPluginBase:: |
public | property | Stores the rendered output of the display. | |
DisplayPluginBase:: |
protected | property | An array of instantiated plugins used in this display. | |
DisplayPluginBase:: |
protected | property | Whether the display allows area plugins. | 1 |
DisplayPluginBase:: |
protected | property | Whether the display allows attachments. | 4 |
DisplayPluginBase:: |
protected | property | Whether the display allows the use of a 'more' link or not. | |
DisplayPluginBase:: |
protected | property |
Overrides Drupal\views\Plugin\Plugin::$usesOptions. Overrides PluginBase:: |
|
DisplayPluginBase:: |
property |
The top object of a view. Overrides PluginBase:: |
||
DisplayPluginBase:: |
public | function | Determines whether this display can use attachments. | |
DisplayPluginBase:: |
public | function | Determine if the user has access to this display of the view. | |
DisplayPluginBase:: |
public | function |
Clears a plugin. Overrides PluginBase:: |
|
DisplayPluginBase:: |
public | function | Determine if this display should display the exposed filters widgets, so the view will know whether or not to render them. | 1 |
DisplayPluginBase:: |
protected | function | Format a list of theme templates for output by the theme info helper. | |
DisplayPluginBase:: |
public | function | Returns to tokens for arguments. | |
DisplayPluginBase:: |
public | function | Provide some helpful text for the arguments. The result should contain of an array with | 1 |
DisplayPluginBase:: |
public | function | Retrieve a list of fields for the current display with the relationship associated if it exists. | |
DisplayPluginBase:: |
public | function | Get the handler object for a single handler. | |
DisplayPluginBase:: |
public | function | Get a full array of handlers for $type. This caches them. | |
DisplayPluginBase:: |
public | function | Check to see which display to use when creating links within a view using this display. | |
DisplayPluginBase:: |
public | function | Intelligently get an option either from this display or from the default display, if directed to do so. | |
DisplayPluginBase:: |
public | function | Provide some helpful text for pagers. | 1 |
DisplayPluginBase:: |
public | function | Return the base path to use for this display. | |
DisplayPluginBase:: |
public | function | Get the instance of a plugin, for example style or row. | |
DisplayPluginBase:: |
public | function | Provide the block system with any exposed widget blocks for this display. | |
DisplayPluginBase:: |
public | function | ||
DisplayPluginBase:: |
public | function | If this display creates a block, implement one of these. | |
DisplayPluginBase:: |
public | function | If this display creates a page with a menu item, implement it here. | |
DisplayPluginBase:: |
public | function | Whether the display is actually using AJAX or not. | |
DisplayPluginBase:: |
public | function | Determine if this display is the 'default' display which contains fallback settings | 1 |
DisplayPluginBase:: |
public | function | Determine if a given option is set to use the default display or the current display | |
DisplayPluginBase:: |
public | function | Whether the display is enabled. | |
DisplayPluginBase:: |
public | function | Check if the provided identifier is unique. | |
DisplayPluginBase:: |
public | function | Whether the display is using the 'more' link or not. | |
DisplayPluginBase:: |
public | function | Whether the display is using a pager or not. | |
DisplayPluginBase:: |
public | function | Because forms may be split up into sections, this provides an easy URL to exactly the right section. Don't override this. | |
DisplayPluginBase:: |
public | function | If override/revert was clicked, perform the proper toggle. | |
DisplayPluginBase:: |
public | function | Set an option and force it to be an override. | |
DisplayPluginBase:: |
public | function | Set up any variables on the view prior to execution. These are separated from execute because they are extremely common and unlikely to be overridden on an individual display. | |
DisplayPluginBase:: |
public | function |
Inject anything into the query that the display handler needs. Overrides PluginBase:: |
|
DisplayPluginBase:: |
public | function | ||
DisplayPluginBase:: |
public | function | ||
DisplayPluginBase:: |
public | function | Not all display plugins will support filtering | |
DisplayPluginBase:: |
public | function | Render the footer of the view. | |
DisplayPluginBase:: |
public | function | Render the header of the view. | |
DisplayPluginBase:: |
public | function | Render the 'more' link | |
DisplayPluginBase:: |
public | function | Not all display plugins will suppert pager rendering. | 1 |
DisplayPluginBase:: |
public | function | Intelligently set an option either from this display or from the default display, if directed to do so. | |
DisplayPluginBase:: |
public | function | Flip the override setting for the given section. | |
DisplayPluginBase:: |
public | function | Does the display have groupby enabled? | |
DisplayPluginBase:: |
public | function | Should the enabled display more link be shown when no more items? | |
DisplayPluginBase:: |
public | function | Does the display have custom link text? | |
DisplayPluginBase:: |
public | function | Whether the display allows the use of AJAX or not. | 1 |
DisplayPluginBase:: |
public | function | Returns whether the display can use areas. | 1 |
DisplayPluginBase:: |
public | function | Returns whether the display can use attachments. | 4 |
DisplayPluginBase:: |
public | function | Check to see if the display needs a breadcrumb | 1 |
DisplayPluginBase:: |
public | function | Determine if this display uses exposed filters, so the view will know whether or not to build them. | 2 |
DisplayPluginBase:: |
public | function | Check to see if the display can put the exposed formin a block. | |
DisplayPluginBase:: |
public | function | Determine if the display's style uses fields. | |
DisplayPluginBase:: |
public | function | Whether the display allows the use of a 'more' link or not. | |
DisplayPluginBase:: |
public | function | Whether the display allows the use of a pager or not. | 2 |
DisplayPluginBase:: |
public | function |
Make sure the display and all associated handlers are valid. Overrides PluginBase:: |
1 |
DisplayPluginBase:: |
public | function | Render any special blocks provided for this display. | |
Feed:: |
protected | property |
Whether the display allows the use of AJAX or not. Overrides DisplayPluginBase:: |
|
Feed:: |
protected | property |
Whether the display allows the use of a pager or not. Overrides DisplayPluginBase:: |
|
Feed:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::attachTo(). Overrides DisplayPluginBase:: |
|
Feed:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\PathPluginBase::buildOptionsForm(). Overrides PathPluginBase:: |
|
Feed:: |
public | function |
Overrides \Drupal\views\Plugin\views\displays\DisplayPluginBase::defaultableSections(). Overrides DisplayPluginBase:: |
|
Feed:: |
protected | function |
Overrides \Drupal\views\Plugin\views\display\PathPluginBase::defineOptions(). Overrides PathPluginBase:: |
|
Feed:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\PathPluginBase::execute(). Overrides PathPluginBase:: |
|
Feed:: |
protected | function |
Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::getStyleType(). Overrides DisplayPluginBase:: |
|
Feed:: |
public | function |
Overrides DisplayPluginBase:: |
|
Feed:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::optionsSummary(). Overrides PathPluginBase:: |
|
Feed:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\PathPluginBase::preview(). Overrides DisplayPluginBase:: |
|
Feed:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\PathPluginBase::render(). Overrides DisplayPluginBase:: |
|
Feed:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::submitOptionsForm(). Overrides PathPluginBase:: |
|
Feed:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::usesLinkDisplay(). Overrides DisplayPluginBase:: |
|
PathPluginBase:: |
public | function | Add this display's path information to Drupal's menu system. | |
PathPluginBase:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::hasPath(). Overrides DisplayPluginBase:: |
|
PathPluginBase:: |
public | function |
Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase::validateOptionsForm(). Overrides DisplayPluginBase:: |
1 |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
public | property | Plugins's definition | |
PluginBase:: |
protected | property | The discovery object. | |
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_id. | |
PluginBase:: |
public | function | Provide a list of additional theme functions for the theme information page | |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). 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 | ||
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:: |