RSSEnclosureFormatter.php

Same filename in other branches
  1. 8.9.x core/modules/file/src/Plugin/Field/FieldFormatter/RSSEnclosureFormatter.php
  2. 10 core/modules/file/src/Plugin/Field/FieldFormatter/RSSEnclosureFormatter.php
  3. 11.x core/modules/file/src/Plugin/Field/FieldFormatter/RSSEnclosureFormatter.php

Namespace

Drupal\file\Plugin\Field\FieldFormatter

File

core/modules/file/src/Plugin/Field/FieldFormatter/RSSEnclosureFormatter.php

View source
<?php

namespace Drupal\file\Plugin\Field\FieldFormatter;

use Drupal\Core\Field\FieldItemListInterface;

/**
 * Plugin implementation of the 'file_rss_enclosure' formatter.
 *
 * @FieldFormatter(
 *   id = "file_rss_enclosure",
 *   label = @Translation("RSS enclosure"),
 *   field_types = {
 *     "file"
 *   }
 * )
 */
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 [];
    }

}

Classes

Title Deprecated Summary
RSSEnclosureFormatter Plugin implementation of the 'file_rss_enclosure' formatter.

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