class Rss

Same name in this branch
  1. 8.9.x core/modules/node/src/Plugin/views/row/Rss.php \Drupal\node\Plugin\views\row\Rss
  2. 8.9.x core/modules/views/src/Plugin/views/style/Rss.php \Drupal\views\Plugin\views\style\Rss
  3. 8.9.x core/modules/comment/src/Plugin/views/row/Rss.php \Drupal\comment\Plugin\views\row\Rss
Same name in other branches
  1. 9 core/modules/node/src/Plugin/views/row/Rss.php \Drupal\node\Plugin\views\row\Rss
  2. 9 core/modules/views/src/Plugin/views/style/Rss.php \Drupal\views\Plugin\views\style\Rss
  3. 9 core/modules/aggregator/src/Plugin/views/row/Rss.php \Drupal\aggregator\Plugin\views\row\Rss
  4. 9 core/modules/comment/src/Plugin/views/row/Rss.php \Drupal\comment\Plugin\views\row\Rss
  5. 10 core/modules/node/src/Plugin/views/row/Rss.php \Drupal\node\Plugin\views\row\Rss
  6. 10 core/modules/views/src/Plugin/views/style/Rss.php \Drupal\views\Plugin\views\style\Rss
  7. 10 core/modules/comment/src/Plugin/views/row/Rss.php \Drupal\comment\Plugin\views\row\Rss
  8. 11.x core/modules/node/src/Plugin/views/row/Rss.php \Drupal\node\Plugin\views\row\Rss
  9. 11.x core/modules/views/src/Plugin/views/style/Rss.php \Drupal\views\Plugin\views\style\Rss
  10. 11.x core/modules/comment/src/Plugin/views/row/Rss.php \Drupal\comment\Plugin\views\row\Rss

Defines a row plugin which loads an aggregator item and renders as RSS.

Plugin annotation


@ViewsRow(
  id = "aggregator_rss",
  theme = "views_view_row_rss",
  title = @Translation("Aggregator item"),
  help = @Translation("Display the aggregator item using the data from the original source."),
  base = {"aggregator_item"},
  display_types = {"feed"}
)

Hierarchy

Expanded class hierarchy of Rss

39 string references to 'Rss'
AggregatorRenderingTest::testFeedPage in core/modules/aggregator/tests/src/Functional/AggregatorRenderingTest.php
Creates a feed and checks that feed's page.
book_node_links_alter in core/modules/book/book.module
Implements hook_node_links_alter().
CommentLinkBuilder::buildCommentedEntityLinks in core/modules/comment/src/CommentLinkBuilder.php
Builds links for the given entity.
CommentLinkBuilderTest::getLinkCombinations in core/modules/comment/tests/src/Unit/CommentLinkBuilderTest.php
Data provider for ::testCommentLinkBuilder.
comment_entity_view in core/modules/comment/comment.module
Implements hook_entity_view().

... See full list

File

core/modules/aggregator/src/Plugin/views/row/Rss.php, line 19

Namespace

Drupal\aggregator\Plugin\views\row
View source
class Rss extends RssPluginBase {
    
    /**
     * The table the aggregator item is using for storage.
     *
     * @var string
     */
    public $base_table = 'aggregator_item';
    
    /**
     * The actual field which is used to identify a aggregator item.
     *
     * @var string
     */
    public $base_field = 'iid';
    
    /**
     * {@inheritdoc}
     */
    protected $entityTypeId = 'aggregator_item';
    
    /**
     * {@inheritdoc}
     */
    public function render($row) {
        $entity = $row->_entity;
        $item = new \stdClass();
        foreach ($entity as $name => $field) {
            $item->{$name} = $field->value;
        }
        $item->elements = [
            [
                'key' => 'pubDate',
                // views_view_row_rss takes care about the escaping.
'value' => gmdate('r', $entity->timestamp->value),
            ],
            [
                'key' => 'dc:creator',
                // views_view_row_rss takes care about the escaping.
'value' => $entity->author->value,
            ],
            [
                'key' => 'guid',
                // views_view_row_rss takes care about the escaping.
'value' => $entity->guid->value,
                'attributes' => [
                    'isPermaLink' => 'false',
                ],
            ],
        ];
        $build = [
            '#theme' => $this->themeFunctions(),
            '#view' => $this->view,
            '#options' => $this->options,
            '#row' => $item,
        ];
        return $build;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
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's 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::$renderer protected property Stores the render API renderer. 3
PluginBase::$view public property The top object of a view. 1
PluginBase::destroy public function Clears a plugin. Overrides ViewsPluginInterface::destroy 2
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 8
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::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks 6
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays
so that defaults don't get totally blown away.
Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface::validate 6
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string. The resulting string will be
sanitized with Xss::filterAdmin.
1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
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
RowPluginBase::$usesFields protected property Does the row plugin support to add fields to its output. 4
RowPluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions 1
RowPluginBase::preRender public function Allow the style to do stuff before each row is rendered. 4
RowPluginBase::query public function Add anything to the query that we might need to. Overrides PluginBase::query 2
RowPluginBase::submitOptionsForm public function Perform any necessary changes to the form values prior to storage.
There is no need for this function to actually store the data.
Overrides PluginBase::submitOptionsForm 1
RowPluginBase::usesFields public function Returns the usesFields property. 4
RowPluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm 1
Rss::$base_field public property The actual field which is used to identify a aggregator item.
Rss::$base_table public property The table the aggregator item is using for storage.
Rss::$entityTypeId protected property The ID of the entity type for which this is an RSS row plugin. Overrides RssPluginBase::$entityTypeId
Rss::render public function Render a row object. This usually passes through to a theme template
of some form, but not always.
Overrides RowPluginBase::render
RssPluginBase::$deprecatedProperties protected property
RssPluginBase::$entityDisplayRepository protected property The entity display repository.
RssPluginBase::$entityTypeManager protected property The entity manager.
RssPluginBase::buildOptionsForm public function Provide a form for setting options. Overrides RowPluginBase::buildOptionsForm
RssPluginBase::buildOptionsForm_summary_options public function Return the main options, which are shown in the summary title. 2
RssPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies
RssPluginBase::create public static function Creates an instance of the plugin. Overrides PluginBase::create
RssPluginBase::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides RowPluginBase::defineOptions
RssPluginBase::__construct public function Constructs a RssPluginBase object. Overrides PluginBase::__construct 1
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING 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.