class Feed
Same name in other branches
- 9 core/modules/views/src/Plugin/views/display/Feed.php \Drupal\views\Plugin\views\display\Feed
- 9 core/modules/aggregator/src/Entity/Feed.php \Drupal\aggregator\Entity\Feed
- 8.9.x core/modules/views/src/Plugin/views/display/Feed.php \Drupal\views\Plugin\views\display\Feed
- 8.9.x core/modules/aggregator/src/Entity/Feed.php \Drupal\aggregator\Entity\Feed
- 11.x core/modules/views/src/Plugin/views/display/Feed.php \Drupal\views\Plugin\views\display\Feed
The plugin that handles a feed, such as RSS or atom.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\views\Plugin\views\display\DisplayPluginBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\display\DisplayPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Plugin\PluginDependencyTrait
- class \Drupal\views\Plugin\views\display\PathPluginBase extends \Drupal\views\Plugin\views\display\DisplayPluginBase implements \Drupal\views\Plugin\views\display\DisplayRouterInterface, \Drupal\views\Plugin\views\display\DisplayMenuInterface
- class \Drupal\views\Plugin\views\display\Feed extends \Drupal\views\Plugin\views\display\PathPluginBase implements \Drupal\views\Plugin\views\display\ResponseDisplayPluginInterface
- class \Drupal\views\Plugin\views\display\PathPluginBase extends \Drupal\views\Plugin\views\display\DisplayPluginBase implements \Drupal\views\Plugin\views\display\DisplayRouterInterface, \Drupal\views\Plugin\views\display\DisplayMenuInterface
- class \Drupal\views\Plugin\views\display\DisplayPluginBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\display\DisplayPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Plugin\PluginDependencyTrait
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of Feed
Related topics
38 string references to 'Feed'
- BigPipeResponseAttachmentsProcessorTest::attachmentsProvider in core/
modules/ big_pipe/ tests/ src/ Unit/ Render/ BigPipeResponseAttachmentsProcessorTest.php - Block::prepareRow in core/
modules/ block/ src/ Plugin/ migrate/ source/ Block.php - Adds additional data to the row.
- BlockPluginId::transform in core/
modules/ block/ src/ Plugin/ migrate/ process/ BlockPluginId.php - Set the block plugin id.
- Feed::getType in core/
modules/ views/ src/ Plugin/ views/ display/ Feed.php - Returns the display type that this display requires.
- HtmlResponseAttachmentsProcessor::processAttachments in core/
lib/ Drupal/ Core/ Render/ HtmlResponseAttachmentsProcessor.php - Processes the attachments of a response that has attachments.
File
-
core/
modules/ views/ src/ Plugin/ views/ display/ Feed.php, line 23
Namespace
Drupal\views\Plugin\views\displayView source
class Feed extends PathPluginBase implements ResponseDisplayPluginInterface {
/**
* Whether the display allows the use of AJAX or not.
*
* @var bool
*/
protected $ajaxEnabled = FALSE;
/**
* Whether the display allows the use of a pager or not.
*
* @var bool
*/
protected $usesPager = FALSE;
/**
* The renderer.
*
* @var \Drupal\Core\Render\RendererInterface
*/
protected $renderer;
/**
* Constructs a PathPluginBase object.
*
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin_id for the plugin instance.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\Core\Routing\RouteProviderInterface $route_provider
* The route provider.
* @param \Drupal\Core\State\StateInterface $state
* The state key value store.
* @param \Drupal\Core\Render\RendererInterface $renderer
* The renderer.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, RouteProviderInterface $route_provider, StateInterface $state, RendererInterface $renderer) {
parent::__construct($configuration, $plugin_id, $plugin_definition, $route_provider, $state);
$this->renderer = $renderer;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container->get('router.route_provider'), $container->get('state'), $container->get('renderer'));
}
/**
* {@inheritdoc}
*/
public function getType() {
return 'feed';
}
/**
* {@inheritdoc}
*/
public static function buildResponse($view_id, $display_id, array $args = []) {
$build = static::buildBasicRenderable($view_id, $display_id, $args);
// Set up an empty response, so for example RSS can set the proper
// Content-Type header.
$response = new CacheableResponse('', 200);
$build['#response'] = $response;
/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = \Drupal::service('renderer');
$output = (string) $renderer->renderRoot($build);
if (empty($output)) {
throw new NotFoundHttpException();
}
$response->setContent($output);
$cache_metadata = CacheableMetadata::createFromRenderArray($build);
$response->addCacheableDependency($cache_metadata);
// Set the HTTP headers and status code on the response if any bubbled.
if (!empty($build['#attached']['http_header'])) {
static::setHeaders($response, $build['#attached']['http_header']);
}
return $response;
}
/**
* Sets headers on a response object.
*
* @param \Drupal\Core\Cache\CacheableResponse $response
* The HTML response to update.
* @param array $headers
* The headers to set, as an array. The items in this array should be as
* follows:
* - The header name.
* - The header value.
* - (optional) Whether to replace a current value with the new one, or add
* it to the others. If the value is not replaced, it will be appended,
* resulting in a header like this: 'Header: value1,value2'.
*
* @see \Drupal\Core\Render\HtmlResponseAttachmentsProcessor::setHeaders()
*/
protected static function setHeaders(CacheableResponse $response, array $headers) : void {
foreach ($headers as $values) {
$name = $values[0];
$value = $values[1];
$replace = !empty($values[2]);
// Drupal treats the HTTP response status code like a header, even though
// it really is not.
if (strtolower($name) === 'status') {
$response->setStatusCode($value);
}
else {
$response->headers
->set($name, $value, $replace);
}
}
}
/**
* {@inheritdoc}
*/
public function execute() {
parent::execute();
return $this->view
->render();
}
/**
* {@inheritdoc}
*/
public function preview() {
$output = $this->view
->render();
if (!empty($this->view->live_preview)) {
$output = [
'#prefix' => '<pre>',
'#plain_text' => $this->renderer
->renderRoot($output),
'#suffix' => '</pre>',
];
}
return $output;
}
/**
* {@inheritdoc}
*/
public function render() {
$build = $this->view->style_plugin
->render($this->view->result);
$this->applyDisplayCacheabilityMetadata($build);
return $build;
}
/**
* {@inheritdoc}
*/
public function defaultableSections($section = NULL) {
$sections = parent::defaultableSections($section);
if (in_array($section, [
'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;
}
/**
* {@inheritdoc}
*/
protected function defineOptions() {
$options = parent::defineOptions();
$options['displays'] = [
'default' => [],
];
// Overrides for standard stuff.
$options['style']['contains']['type']['default'] = 'rss';
$options['style']['contains']['options']['default'] = [
'description' => '',
];
$options['sitename_title']['default'] = FALSE;
$options['row']['contains']['type']['default'] = 'rss_fields';
$options['defaults']['default']['style'] = FALSE;
$options['defaults']['default']['row'] = FALSE;
return $options;
}
/**
* {@inheritdoc}
*/
public function newDisplay() {
parent::newDisplay();
// 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().
if (empty($this->options['row']['type']) || $this->options['row']['type'] === 'rss_fields') {
$row_plugins = Views::fetchPluginNames('row', $this->getType(), [
$this->view->storage
->get('base_table'),
]);
$default_row_plugin = key($row_plugins);
$options = $this->getOption('row');
$options['type'] = $default_row_plugin;
$this->setOption('row', $options);
}
}
/**
* {@inheritdoc}
*/
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'] = [
'title' => $this->t('Feed settings'),
'column' => 'second',
'build' => [
'#weight' => -10,
],
];
if ($this->getOption('sitename_title')) {
$options['title']['value'] = $this->t('Using the site name');
}
$displays = array_filter($this->getOption('displays'));
if (count($displays) > 1) {
$attach_to = $this->t('Multiple displays');
}
elseif (count($displays) == 1) {
$display = array_shift($displays);
$displays = $this->view->storage
->get('display');
if (!empty($displays[$display])) {
$attach_to = $displays[$display]['display_title'];
}
}
if (!isset($attach_to)) {
$attach_to = $this->t('None');
}
$options['displays'] = [
'category' => 'page',
'title' => $this->t('Attach to'),
'value' => $attach_to,
];
}
/**
* {@inheritdoc}
*/
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
// It is very important to call the parent function here.
parent::buildOptionsForm($form, $form_state);
switch ($form_state->get('section')) {
case 'title':
$title = $form['title'];
// A little juggling to move the 'title' field beyond our checkbox.
unset($form['title']);
$form['sitename_title'] = [
'#type' => 'checkbox',
'#title' => $this->t('Use the site name for the title'),
'#default_value' => $this->getOption('sitename_title'),
];
$form['title'] = $title;
$form['title']['#states'] = [
'visible' => [
':input[name="sitename_title"]' => [
'checked' => FALSE,
],
],
];
break;
case 'displays':
$form['#title'] .= $this->t('Attach to');
$displays = [];
foreach ($this->view->storage
->get('display') as $display_id => $display) {
// @todo The display plugin should have display_title and id as well.
if ($this->view->displayHandlers
->has($display_id) && $this->view->displayHandlers
->get($display_id)
->acceptAttachments()) {
$displays[$display_id] = $display['display_title'];
}
}
$form['displays'] = [
'#title' => $this->t('Displays'),
'#type' => 'checkboxes',
'#description' => $this->t('The feed icon will be available only to the selected displays.'),
'#options' => array_map('\\Drupal\\Component\\Utility\\Html::escape', $displays),
'#default_value' => $this->getOption('displays'),
];
break;
case 'path':
$form['path']['#description'] = $this->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.');
}
}
/**
* {@inheritdoc}
*/
public function submitOptionsForm(&$form, FormStateInterface $form_state) {
parent::submitOptionsForm($form, $form_state);
$section = $form_state->get('section');
switch ($section) {
case 'title':
$this->setOption('sitename_title', $form_state->getValue('sitename_title'));
break;
case 'displays':
$this->setOption($section, $form_state->getValue($section));
break;
}
}
/**
* {@inheritdoc}
*/
public function attachTo(ViewExecutable $view, $display_id, array &$build) {
$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.
$view->setArguments($this->view->args);
$view->setDisplay($this->display['id']);
$view->buildTitle();
if ($plugin = $view->display_handler
->getPlugin('style')) {
$plugin->attachTo($build, $display_id, $view->getUrl(), $view->getTitle());
foreach ($view->feedIcons as $feed_icon) {
$this->view->feedIcons[] = $feed_icon;
}
}
}
/**
* {@inheritdoc}
*/
public function usesLinkDisplay() {
return TRUE;
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
DependencyTrait::$dependencies | protected | property | The object's dependencies. | |||
DependencyTrait::addDependencies | protected | function | Adds multiple dependencies. | |||
DependencyTrait::addDependency | protected | function | Adds a dependency. | |||
DerivativeInspectionInterface::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | 1 | ||
DerivativeInspectionInterface::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | 1 | ||
DisplayPluginBase::$default_display | public | property | ||||
DisplayPluginBase::$display | public | property | The display information coming directly from the view entity. | |||
DisplayPluginBase::$extenders | protected | property | Stores all available display extenders. | |||
DisplayPluginBase::$handlers | public | property | An array of instantiated handlers used in this display. | |||
DisplayPluginBase::$has_exposed | public | property | ||||
DisplayPluginBase::$output | public | property | Stores the rendered output of the display. | |||
DisplayPluginBase::$plugins | protected | property | An array of instantiated plugins used in this display. | |||
DisplayPluginBase::$unpackOptions | protected static | property | Static cache for unpackOptions, but not if we are in the UI. | |||
DisplayPluginBase::$usesAJAX | protected | property | Whether the display allows the use of AJAX or not. | 2 | ||
DisplayPluginBase::$usesAreas | protected | property | Whether the display allows area plugins. | 2 | ||
DisplayPluginBase::$usesAttachments | protected | property | Whether the display allows attachments. | 6 | ||
DisplayPluginBase::$usesMore | protected | property | Whether the display allows the use of a 'more' link or not. | 1 | ||
DisplayPluginBase::$usesOptions | protected | property | Denotes whether the plugin has an additional options form. | Overrides PluginBase::$usesOptions | 1 | |
DisplayPluginBase::$view | public | property | The top object of a view. | Overrides PluginBase::$view | ||
DisplayPluginBase::acceptAttachments | public | function | Determines whether this display can use attachments. | Overrides DisplayPluginInterface::acceptAttachments | ||
DisplayPluginBase::access | public | function | Determines if the user has access to this display of the view. | Overrides DisplayPluginInterface::access | ||
DisplayPluginBase::ajaxEnabled | public | function | Whether the display is actually using AJAX or not. | Overrides DisplayPluginInterface::ajaxEnabled | ||
DisplayPluginBase::applyDisplayCacheabilityMetadata | protected | function | Applies the cacheability of the current display to the given render array. | |||
DisplayPluginBase::buildBasicRenderable | public static | function | Builds a basic render array which can be properly render cached. | Overrides DisplayPluginInterface::buildBasicRenderable | 1 | |
DisplayPluginBase::buildRenderable | public | function | Builds a renderable array of the view. | Overrides DisplayPluginInterface::buildRenderable | 1 | |
DisplayPluginBase::buildRenderingLanguageOptions | protected | function | Returns the available rendering strategies for language-aware entities. | |||
DisplayPluginBase::calculateCacheMetadata | public | function | Calculates the display's cache metadata by inspecting each handler/plugin. | Overrides DisplayPluginInterface::calculateCacheMetadata | ||
DisplayPluginBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides PluginBase::calculateDependencies | 2 | |
DisplayPluginBase::destroy | public | function | Clears a plugin. | Overrides PluginBase::destroy | ||
DisplayPluginBase::displaysExposed | public | function | Determines if this display should display the exposed filters widgets. | Overrides DisplayPluginInterface::displaysExposed | 2 | |
DisplayPluginBase::elementPreRender | public | function | #pre_render callback for view display rendering. | Overrides DisplayPluginInterface::elementPreRender | ||
DisplayPluginBase::getAllHandlers | protected | function | Gets all the handlers used by the display. | |||
DisplayPluginBase::getAllPlugins | protected | function | Gets all the plugins used by the display. | |||
DisplayPluginBase::getArgumentsTokens | public | function | Returns to tokens for arguments. | Overrides DisplayPluginInterface::getArgumentsTokens | ||
DisplayPluginBase::getArgumentText | public | function | Provides help text for the arguments. | Overrides DisplayPluginInterface::getArgumentText | 1 | |
DisplayPluginBase::getAttachedDisplays | public | function | Find out all displays which are attached to this display. | Overrides DisplayPluginInterface::getAttachedDisplays | ||
DisplayPluginBase::getCacheMetadata | public | function | Gets the cache metadata. | Overrides DisplayPluginInterface::getCacheMetadata | ||
DisplayPluginBase::getExtenders | public | function | Gets the display extenders. | Overrides DisplayPluginInterface::getExtenders | ||
DisplayPluginBase::getFieldLabels | public | function | Retrieves a list of fields for the current display. | Overrides DisplayPluginInterface::getFieldLabels | ||
DisplayPluginBase::getHandler | public | function | Get the handler object for a single handler. | Overrides DisplayPluginInterface::getHandler | ||
DisplayPluginBase::getHandlers | public | function | Get a full array of handlers for $type. This caches them. | Overrides DisplayPluginInterface::getHandlers | ||
DisplayPluginBase::getLinkDisplay | public | function | Returns the ID of the display to use when making links. | Overrides DisplayPluginInterface::getLinkDisplay | ||
DisplayPluginBase::getMoreUrl | protected | function | Get the more URL for this view. | |||
DisplayPluginBase::getOption | public | function | Gets an option, from this display or the default display. | Overrides DisplayPluginInterface::getOption | ||
DisplayPluginBase::getPagerText | public | function | Provides help text for pagers. | Overrides DisplayPluginInterface::getPagerText | 1 | |
DisplayPluginBase::getPlugin | public | function | Get the instance of a plugin, for example style or row. | Overrides DisplayPluginInterface::getPlugin | ||
DisplayPluginBase::getRoutedDisplay | public | function | Points to the display which can be linked by this display. | Overrides DisplayPluginInterface::getRoutedDisplay | ||
DisplayPluginBase::getSpecialBlocks | public | function | Provides the block system with any exposed widget blocks for this display. | Overrides DisplayPluginInterface::getSpecialBlocks | ||
DisplayPluginBase::getUrl | public | function | Returns a URL to $this display or its configured linked display. | Overrides DisplayPluginInterface::getUrl | ||
DisplayPluginBase::initDisplay | public | function | Initializes the display plugin. | Overrides DisplayPluginInterface::initDisplay | 1 | |
DisplayPluginBase::isBaseTableTranslatable | protected | function | Returns whether the base table is of a translatable entity type. | |||
DisplayPluginBase::isDefaultDisplay | public | function | Determines if this display is the 'default' display. | Overrides DisplayPluginInterface::isDefaultDisplay | 1 | |
DisplayPluginBase::isDefaulted | public | function | Determines if an option is set to use the default or current display. | Overrides DisplayPluginInterface::isDefaulted | ||
DisplayPluginBase::isEnabled | public | function | Whether the display is enabled. | Overrides DisplayPluginInterface::isEnabled | ||
DisplayPluginBase::isIdentifierUnique | public | function | Checks if the provided identifier is unique. | Overrides DisplayPluginInterface::isIdentifierUnique | ||
DisplayPluginBase::isMoreEnabled | public | function | Whether the display is using the 'more' link or not. | Overrides DisplayPluginInterface::isMoreEnabled | ||
DisplayPluginBase::isPagerEnabled | public | function | Whether the display is using a pager or not. | Overrides DisplayPluginInterface::isPagerEnabled | ||
DisplayPluginBase::mergeDefaults | public | function | Merges default values for all plugin types. | Overrides DisplayPluginInterface::mergeDefaults | ||
DisplayPluginBase::mergeHandler | protected | function | Merges handlers default values. | |||
DisplayPluginBase::mergePlugin | protected | function | Merges plugins default values. | |||
DisplayPluginBase::optionLink | public | function | Returns a link to a section of a form. | Overrides DisplayPluginInterface::optionLink | ||
DisplayPluginBase::optionsOverride | public | function | If override/revert was clicked, perform the proper toggle. | Overrides DisplayPluginInterface::optionsOverride | ||
DisplayPluginBase::outputIsEmpty | public | function | Is the output of the view empty. | Overrides DisplayPluginInterface::outputIsEmpty | ||
DisplayPluginBase::overrideOption | public | function | Set an option and force it to be an override. | Overrides DisplayPluginInterface::overrideOption | ||
DisplayPluginBase::preExecute | public | function | Sets up any variables on the view prior to execution. | Overrides DisplayPluginInterface::preExecute | ||
DisplayPluginBase::query | public | function | Add anything to the query that we might need to. | Overrides PluginBase::query | 1 | |
DisplayPluginBase::renderArea | public | function | Renders one of the available areas. | Overrides DisplayPluginInterface::renderArea | ||
DisplayPluginBase::renderFilters | public | function | Does nothing (obsolete function). | Overrides DisplayPluginInterface::renderFilters | ||
DisplayPluginBase::renderMoreLink | public | function | Renders the 'more' link. | Overrides DisplayPluginInterface::renderMoreLink | ||
DisplayPluginBase::renderPager | public | function | Checks to see if the display plugins support pager rendering. | Overrides DisplayPluginInterface::renderPager | 1 | |
DisplayPluginBase::setOption | public | function | Sets an option, on this display or the default display. | Overrides DisplayPluginInterface::setOption | ||
DisplayPluginBase::setOverride | public | function | Flip the override setting for the given section. | Overrides DisplayPluginInterface::setOverride | ||
DisplayPluginBase::trustedCallbacks | public static | function | Lists the trusted callbacks provided by the implementing class. | Overrides PluginBase::trustedCallbacks | ||
DisplayPluginBase::useGroupBy | public | function | Does the display have groupby enabled? | Overrides DisplayPluginInterface::useGroupBy | ||
DisplayPluginBase::useMoreAlways | public | function | Should the enabled display more link be shown when no more items? | Overrides DisplayPluginInterface::useMoreAlways | ||
DisplayPluginBase::useMoreText | public | function | Does the display have custom link text? | Overrides DisplayPluginInterface::useMoreText | ||
DisplayPluginBase::usesAJAX | public | function | Whether the display allows the use of AJAX or not. | Overrides DisplayPluginInterface::usesAJAX | 2 | |
DisplayPluginBase::usesAreas | public | function | Returns whether the display can use areas. | Overrides DisplayPluginInterface::usesAreas | 2 | |
DisplayPluginBase::usesAttachments | public | function | Returns whether the display can use attachments. | Overrides DisplayPluginInterface::usesAttachments | 6 | |
DisplayPluginBase::usesExposed | public | function | Determines if this display uses exposed filters. | Overrides DisplayPluginInterface::usesExposed | 3 | |
DisplayPluginBase::usesExposedFormInBlock | public | function | Checks to see if the display can put the exposed form in a block. | Overrides DisplayPluginInterface::usesExposedFormInBlock | 1 | |
DisplayPluginBase::usesFields | public | function | Determines if the display's style uses fields. | Overrides DisplayPluginInterface::usesFields | ||
DisplayPluginBase::usesMore | public | function | Whether the display allows the use of a 'more' link or not. | Overrides DisplayPluginInterface::usesMore | 1 | |
DisplayPluginBase::usesPager | public | function | Whether the display allows the use of a pager or not. | Overrides DisplayPluginInterface::usesPager | 4 | |
DisplayPluginBase::viewExposedFormBlocks | public | function | Renders the exposed form as block. | Overrides DisplayPluginInterface::viewExposedFormBlocks | ||
Feed::$ajaxEnabled | protected | property | Whether the display allows the use of AJAX or not. | |||
Feed::$renderer | protected | property | The renderer. | Overrides PluginBase::$renderer | ||
Feed::$usesPager | protected | property | Whether the display allows the use of a pager or not. | Overrides DisplayPluginBase::$usesPager | ||
Feed::attachTo | public | function | Allows displays to attach to other views. | Overrides DisplayPluginBase::attachTo | ||
Feed::buildOptionsForm | public | function | Provide a form to edit options for this plugin. | Overrides PathPluginBase::buildOptionsForm | ||
Feed::buildResponse | public static | function | Builds up a response with the rendered view as content. | Overrides ResponseDisplayPluginInterface::buildResponse | ||
Feed::create | public static | function | Creates an instance of the plugin. | Overrides PathPluginBase::create | ||
Feed::defaultableSections | public | function | Lists the 'defaultable' sections and what items each section contains. | Overrides DisplayPluginBase::defaultableSections | ||
Feed::defineOptions | protected | function | Overrides \Drupal\views\Plugin\views\display\DisplayPluginBase:defineOptions(). | Overrides PathPluginBase::defineOptions | ||
Feed::execute | public | function | Executes the view and returns data in the format required. | Overrides PathPluginBase::execute | ||
Feed::getType | public | function | Returns the display type that this display requires. | Overrides DisplayPluginBase::getType | ||
Feed::newDisplay | public | function | Reacts on adding a display. | Overrides DisplayPluginBase::newDisplay | ||
Feed::optionsSummary | public | function | Provides the default summary for options in the views UI. | Overrides PathPluginBase::optionsSummary | ||
Feed::preview | public | function | Renders the display for the purposes of a live preview. | Overrides DisplayPluginBase::preview | ||
Feed::render | public | function | Renders this display. | Overrides DisplayPluginBase::render | ||
Feed::setHeaders | protected static | function | Sets headers on a response object. | |||
Feed::submitOptionsForm | public | function | Handle any special handling on the validate form. | Overrides PathPluginBase::submitOptionsForm | ||
Feed::usesLinkDisplay | public | function | Checks to see if the display has some need to link to another display. | Overrides DisplayPluginBase::usesLinkDisplay | ||
Feed::__construct | public | function | Constructs a PathPluginBase object. | Overrides PathPluginBase::__construct | ||
PathPluginBase::$routeProvider | protected | property | The route provider. | |||
PathPluginBase::$state | protected | property | The state key value store. | |||
PathPluginBase::alterRoutes | public | function | Alters a collection of routes and replaces definitions to the view. | Overrides DisplayRouterInterface::alterRoutes | ||
PathPluginBase::collectRoutes | public | function | Adds the route entry of a view to the collection. | Overrides DisplayRouterInterface::collectRoutes | 1 | |
PathPluginBase::getAlteredRouteNames | public | function | Returns the list of routes overridden by Views. | Overrides DisplayRouterInterface::getAlteredRouteNames | ||
PathPluginBase::getMenuLinks | public | function | Gets menu links, if this display provides some. | Overrides DisplayMenuInterface::getMenuLinks | ||
PathPluginBase::getPath | public | function | Returns the base path to use for this display. | Overrides DisplayPluginBase::getPath | ||
PathPluginBase::getRoute | protected | function | Generates a route entry for a given view and display. | 1 | ||
PathPluginBase::getRouteName | public | function | Returns the route name for the display. | Overrides DisplayRouterInterface::getRouteName | ||
PathPluginBase::getUrlInfo | public | function | Generates a URL to this display. | Overrides DisplayRouterInterface::getUrlInfo | ||
PathPluginBase::hasPath | public | function | Checks to see if the display has a 'path' field. | Overrides DisplayPluginBase::hasPath | ||
PathPluginBase::isDefaultTabPath | protected | function | Determines if this display's path is a default tab. | |||
PathPluginBase::overrideApplies | protected | function | Determines whether the view overrides the given route. | 1 | ||
PathPluginBase::overrideAppliesPathAndMethod | protected | function | Determines whether an override for the path and method should happen. | |||
PathPluginBase::remove | public | function | Reacts on deleting a display. | Overrides DisplayPluginBase::remove | ||
PathPluginBase::validate | public | function | Validate that the plugin is correct and can be saved. | Overrides DisplayPluginBase::validate | 1 | |
PathPluginBase::validateOptionsForm | public | function | Validate the options form. | Overrides DisplayPluginBase::validateOptionsForm | 1 | |
PathPluginBase::validatePath | protected | function | Validates the path of the display. | |||
PluginBase::$definition | public | property | Plugins' definition. | |||
PluginBase::$displayHandler | public | property | The display object this plugin is for. | |||
PluginBase::$options | public | property | Options for this plugin will be held here. | |||
PluginBase::$position | public | property | The handler position. | |||
PluginBase::doFilterByDefinedOptions | protected | function | Do the work to filter out stored options depending on the defined options. | |||
PluginBase::filterByDefinedOptions | public | function | Filter out stored options depending on the defined options. | Overrides ViewsPluginInterface::filterByDefinedOptions | ||
PluginBase::getAvailableGlobalTokens | public | function | Returns an array of available token replacements. | Overrides ViewsPluginInterface::getAvailableGlobalTokens | ||
PluginBase::getProvider | public | function | Returns the plugin provider. | Overrides ViewsPluginInterface::getProvider | ||
PluginBase::getRenderer | protected | function | Returns the render API renderer. | 1 | ||
PluginBase::globalTokenForm | public | function | Adds elements for available core tokens to a form. | Overrides ViewsPluginInterface::globalTokenForm | ||
PluginBase::globalTokenReplace | public | function | Returns a string with any core tokens replaced. | Overrides ViewsPluginInterface::globalTokenReplace | ||
PluginBase::INCLUDE_ENTITY | constant | Include entity row languages when listing languages. | ||||
PluginBase::INCLUDE_NEGOTIATED | constant | Include negotiated languages when listing languages. | ||||
PluginBase::init | public | function | Initialize the plugin. | Overrides ViewsPluginInterface::init | 6 | |
PluginBase::listLanguages | protected | function | Makes an array of languages, optionally including special languages. | |||
PluginBase::pluginTitle | public | function | Return the human readable name of the display. | Overrides ViewsPluginInterface::pluginTitle | ||
PluginBase::preRenderAddFieldsetMarkup | public static | function | Moves form elements into fieldsets for presentation purposes. | Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup | ||
PluginBase::preRenderFlattenData | public static | function | Flattens the structure of form elements. | Overrides ViewsPluginInterface::preRenderFlattenData | ||
PluginBase::queryLanguageSubstitutions | public static | function | Returns substitutions for Views queries for languages. | |||
PluginBase::setOptionDefaults | protected | function | Fills up the options of the plugin with defaults. | |||
PluginBase::summaryTitle | public | function | Returns the summary of the settings in the display. | Overrides ViewsPluginInterface::summaryTitle | 6 | |
PluginBase::themeFunctions | public | function | Provide a full list of possible theme templates used by this style. | Overrides ViewsPluginInterface::themeFunctions | 1 | |
PluginBase::unpackOptions | public | function | Unpacks options over our existing defaults. | Overrides ViewsPluginInterface::unpackOptions | ||
PluginBase::usesOptions | public | function | Returns the usesOptions property. | Overrides ViewsPluginInterface::usesOptions | 8 | |
PluginBase::viewsTokenReplace | protected | function | Replaces Views' tokens in a given string. | 1 | ||
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT | constant | Query string to indicate the site default language. | ||||
PluginDependencyTrait::calculatePluginDependencies | protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 | ||
PluginDependencyTrait::getPluginDependencies | protected | function | Calculates and returns dependencies of a specific plugin instance. | |||
PluginDependencyTrait::moduleHandler | protected | function | Wraps the module handler. | 1 | ||
PluginDependencyTrait::themeHandler | protected | function | Wraps the theme handler. | 1 | ||
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | ||
PluginInspectionInterface::getPluginId | public | function | Gets the plugin_id of the plugin instance. | 2 | ||
TrustedCallbackInterface::THROW_EXCEPTION | constant | Untrusted callbacks throw exceptions. | ||||
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION | constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | ||||
TrustedCallbackInterface::TRIGGER_WARNING | Deprecated | constant | Untrusted callbacks trigger E_USER_WARNING errors. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.