class RSSEnclosureFormatter

Same name in other branches
  1. 9 core/modules/file/src/Plugin/Field/FieldFormatter/RSSEnclosureFormatter.php \Drupal\file\Plugin\Field\FieldFormatter\RSSEnclosureFormatter
  2. 8.9.x core/modules/file/src/Plugin/Field/FieldFormatter/RSSEnclosureFormatter.php \Drupal\file\Plugin\Field\FieldFormatter\RSSEnclosureFormatter
  3. 10 core/modules/file/src/Plugin/Field/FieldFormatter/RSSEnclosureFormatter.php \Drupal\file\Plugin\Field\FieldFormatter\RSSEnclosureFormatter

Plugin implementation of the 'file_rss_enclosure' formatter.

Hierarchy

Expanded class hierarchy of RSSEnclosureFormatter

File

core/modules/file/src/Plugin/Field/FieldFormatter/RSSEnclosureFormatter.php, line 12

Namespace

Drupal\file\Plugin\Field\FieldFormatter
View source
class RSSEnclosureFormatter extends FileFormatterBase {
    
    /**
     * {@inheritdoc}
     */
    public function viewElements(FieldItemListInterface $items, $langcode) {
        $entity = $items->getEntity();
        // Add the first file as an enclosure to the RSS item. RSS allows only one
        // enclosure per item. See: http://wikipedia.org/wiki/RSS_enclosure
        foreach ($this->getEntitiesToView($items, $langcode) as $file) {
            
            /** @var \Drupal\file\FileInterface $file */
            $entity->rss_elements[] = [
                'key' => 'enclosure',
                'attributes' => [
                    // In RSS feeds, it is necessary to use absolute URLs. The 'url.site'
                    // cache context is already associated with RSS feed responses, so it
                    // does not need to be specified here.
'url' => $file->createFileUrl(FALSE),
                    'length' => $file->getSize(),
                    'type' => $file->getMimeType(),
                ],
            ];
        }
        return [];
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
EntityReferenceFormatterBase::getEntitiesToView protected function Returns the referenced entities for display. 1
EntityReferenceFormatterBase::prepareView public function Loads the entities referenced in that field across all the entities being
viewed.
Overrides FormatterBase::prepareView
EntityReferenceFormatterBase::view public function Overrides FormatterBase::view
FileFormatterBase::checkAccess protected function Checks access to the given entity. Overrides EntityReferenceFormatterBase::checkAccess 1
FileFormatterBase::needsEntityLoad protected function Returns whether the entity referenced by an item needs to be loaded. Overrides EntityReferenceFormatterBase::needsEntityLoad 1
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::create public static function Overrides ContainerFactoryPluginInterface::create 13
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Overrides FormatterInterface::isApplicable 12
FormatterBase::settingsForm public function Overrides FormatterInterface::settingsForm 24
FormatterBase::settingsSummary public function Overrides FormatterInterface::settingsSummary 23
FormatterBase::__construct public function Constructs a FormatterBase object. 13
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
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::defaultSettings public static function Overrides PluginSettingsInterface::defaultSettings 42
PluginSettingsBase::getSetting public function Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
RSSEnclosureFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.