class Rss
Same name in this branch
- 11.x core/modules/node/src/Plugin/views/row/Rss.php \Drupal\node\Plugin\views\row\Rss
- 11.x core/modules/comment/src/Plugin/views/row/Rss.php \Drupal\comment\Plugin\views\row\Rss
Same name in other branches
- 9 core/modules/node/src/Plugin/views/row/Rss.php \Drupal\node\Plugin\views\row\Rss
- 9 core/modules/views/src/Plugin/views/style/Rss.php \Drupal\views\Plugin\views\style\Rss
- 9 core/modules/aggregator/src/Plugin/views/row/Rss.php \Drupal\aggregator\Plugin\views\row\Rss
- 9 core/modules/comment/src/Plugin/views/row/Rss.php \Drupal\comment\Plugin\views\row\Rss
- 8.9.x core/modules/node/src/Plugin/views/row/Rss.php \Drupal\node\Plugin\views\row\Rss
- 8.9.x core/modules/views/src/Plugin/views/style/Rss.php \Drupal\views\Plugin\views\style\Rss
- 8.9.x core/modules/aggregator/src/Plugin/views/row/Rss.php \Drupal\aggregator\Plugin\views\row\Rss
- 8.9.x core/modules/comment/src/Plugin/views/row/Rss.php \Drupal\comment\Plugin\views\row\Rss
- 10 core/modules/node/src/Plugin/views/row/Rss.php \Drupal\node\Plugin\views\row\Rss
- 10 core/modules/views/src/Plugin/views/style/Rss.php \Drupal\views\Plugin\views\style\Rss
- 10 core/modules/comment/src/Plugin/views/row/Rss.php \Drupal\comment\Plugin\views\row\Rss
Default style plugin to render an RSS feed.
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\style\StylePluginBase extends \Drupal\views\Plugin\views\PluginBase
- class \Drupal\views\Plugin\views\style\Rss extends \Drupal\views\Plugin\views\style\StylePluginBase
- class \Drupal\views\Plugin\views\style\StylePluginBase extends \Drupal\views\Plugin\views\PluginBase
- 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 Rss
Related topics
49 string references to 'Rss'
- book_node_links_alter in core/
modules/ book/ book.module - Implements hook_node_links_alter().
- CommentHooks::entityView in core/
modules/ comment/ src/ Hook/ CommentHooks.php - Implements hook_entity_view().
- CommentLinkBuilder::buildCommentedEntityLinks in core/
modules/ comment/ src/ CommentLinkBuilder.php - CommentLinkBuilderTest::getLinkCombinations in core/
modules/ comment/ tests/ src/ Unit/ CommentLinkBuilderTest.php - Data provider for ::testCommentLinkBuilder.
- ConfigNamesMapperTest::testGetConfigData in core/
modules/ config_translation/ tests/ src/ Unit/ ConfigNamesMapperTest.php - Tests ConfigNamesMapper::getConfigData().
File
-
core/
modules/ views/ src/ Plugin/ views/ style/ Rss.php, line 15
Namespace
Drupal\views\Plugin\views\styleView source
class Rss extends StylePluginBase {
/**
* The RSS namespaces.
*/
public array $namespaces;
/**
* The channel elements.
*/
// phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName, Drupal.Commenting.VariableComment.Missing
public array $channel_elements;
/**
* {@inheritdoc}
*/
protected $usesRowPlugin = TRUE;
public function attachTo(array &$build, $display_id, Url $feed_url, $title) {
$url_options = [];
$input = $this->view
->getExposedInput();
if ($input) {
$url_options['query'] = $input;
}
$url_options['absolute'] = TRUE;
$url = $feed_url->setOptions($url_options)
->toString();
// Add the RSS icon to the view.
$this->view->feedIcons[] = [
'#theme' => 'feed_icon',
'#url' => $url,
'#title' => $title,
];
// Attach a link to the RSS feed, which is an alternate representation.
$build['#attached']['html_head_link'][][] = [
'rel' => 'alternate',
'type' => 'application/rss+xml',
'title' => $title,
'href' => $url,
];
}
protected function defineOptions() {
$options = parent::defineOptions();
$options['description'] = [
'default' => '',
];
return $options;
}
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
parent::buildOptionsForm($form, $form_state);
$form['description'] = [
'#type' => 'textfield',
'#title' => $this->t('RSS description'),
'#default_value' => $this->options['description'],
'#description' => $this->t('This will appear in the RSS feed itself.'),
'#maxlength' => 1024,
];
}
/**
* Return an array of additional XHTML elements to add to the channel.
*
* @return array
* A render array.
*/
protected function getChannelElements() {
return [];
}
/**
* 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;
}
public function render() {
$rows = [];
// This will be filled in by the row plugin and is used later on in the
// theming output.
$this->namespaces = [
'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);
}
$build = [
'#theme' => $this->themeFunctions(),
'#view' => $this->view,
'#options' => $this->options,
'#rows' => $rows,
'#attached' => [
'http_header' => [
[
'Content-Type',
'application/rss+xml; charset=utf-8',
],
],
],
];
unset($this->view->row_index);
return $build;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
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 | |
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::$renderer | protected | property | Stores the render API renderer. | 3 | |
PluginBase::$view | public | property | The top object of a view. | 1 | |
PluginBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | 14 |
PluginBase::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | 61 |
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::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::submitOptionsForm | public | function | Handle any special handling on the validate form. | Overrides ViewsPluginInterface::submitOptionsForm | 16 |
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. | |||
PluginBase::__construct | public | function | Constructs a PluginBase object. | 19 | |
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 | |
Rss::$channel_elements | public | property | |||
Rss::$namespaces | public | property | The RSS namespaces. | ||
Rss::$usesRowPlugin | protected | property | Whether or not this style uses a row plugin. | Overrides StylePluginBase::$usesRowPlugin | |
Rss::attachTo | public | function | |||
Rss::buildOptionsForm | public | function | Provide a form to edit options for this plugin. | Overrides StylePluginBase::buildOptionsForm | |
Rss::defineOptions | protected | function | Information about options for all kinds of purposes will be held here. | Overrides StylePluginBase::defineOptions | |
Rss::getChannelElements | protected | function | Return an array of additional XHTML elements to add to the channel. | ||
Rss::getDescription | public | function | Get RSS feed description. | ||
Rss::render | public | function | Render the display in this style. | Overrides StylePluginBase::render | |
StylePluginBase::$defaultFieldLabels | protected | property | Should field labels be enabled by default. | 1 | |
StylePluginBase::$groupingTheme | protected | property | The theme function used to render the grouping set. | ||
StylePluginBase::$rendered_fields | protected | property | |||
StylePluginBase::$render_tokens | public | property | |||
StylePluginBase::$rowTokens | protected | property | Store all available tokens row rows. | ||
StylePluginBase::$usesFields | protected | property | Does the style plugin for itself support to add fields to its output. | 3 | |
StylePluginBase::$usesGrouping | protected | property | Does the style plugin support grouping of rows. | 3 | |
StylePluginBase::$usesOptions | protected | property | Denotes whether the plugin has an additional options form. | Overrides PluginBase::$usesOptions | |
StylePluginBase::$usesRowClass | protected | property | Does the style plugin support custom css class for the rows. | 3 | |
StylePluginBase::buildSort | public | function | Determines if the style handler should interfere with sorts. | 1 | |
StylePluginBase::buildSortPost | public | function | Allows the view builder to build a second set of sorts. | 1 | |
StylePluginBase::defaultFieldLabels | public | function | Return TRUE if this style enables field labels by default. | 1 | |
StylePluginBase::destroy | public | function | Clears a plugin. | Overrides PluginBase::destroy | |
StylePluginBase::elementPreRenderRow | public | function | #pre_render callback for view row field rendering. | ||
StylePluginBase::evenEmpty | public | function | Determines if the style plugin is rendered even if the view is empty. | 2 | |
StylePluginBase::getField | public | function | Gets a rendered field. | ||
StylePluginBase::getFieldValue | public | function | Get the raw field value. | ||
StylePluginBase::getRowClass | public | function | Return the token replaced row class for the specified row. | ||
StylePluginBase::init | public | function | Overrides \Drupal\views\Plugin\views\PluginBase::init(). | Overrides PluginBase::init | |
StylePluginBase::preRender | public | function | Allow the style to do stuff before each row is rendered. | ||
StylePluginBase::query | public | function | Add anything to the query that we might need to. | Overrides PluginBase::query | 1 |
StylePluginBase::renderFields | protected | function | Renders all of the fields for a given style and store them on the object. | ||
StylePluginBase::renderGrouping | public | function | Group records as needed for rendering. | ||
StylePluginBase::renderGroupingSets | public | function | Render the grouping sets. | ||
StylePluginBase::renderRowGroup | protected | function | Renders a group of rows of the grouped view. | ||
StylePluginBase::tokenizeValue | public | function | Take a value and apply token replacement logic to it. | ||
StylePluginBase::trustedCallbacks | public static | function | Lists the trusted callbacks provided by the implementing class. | Overrides PluginBase::trustedCallbacks | |
StylePluginBase::usesFields | public | function | Return TRUE if this style also uses fields. | 3 | |
StylePluginBase::usesGrouping | public | function | Returns the usesGrouping property. | 3 | |
StylePluginBase::usesRowClass | public | function | Returns the usesRowClass property. | 3 | |
StylePluginBase::usesRowPlugin | public | function | Returns the usesRowPlugin property. | 11 | |
StylePluginBase::usesTokens | public | function | Return TRUE if this style uses tokens. | ||
StylePluginBase::validate | public | function | Validate that the plugin is correct and can be saved. | Overrides PluginBase::validate | |
StylePluginBase::validateOptionsForm | public | function | Validate the options form. | Overrides PluginBase::validateOptionsForm | |
StylePluginBase::wizardSubmit | public | function | Alter the options of a display before they are added to the view. | 1 | |
TrustedCallbackInterface::THROW_EXCEPTION | constant | Untrusted callbacks throw exceptions. | |||
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION | constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.