class EntityReferenceTaxonomyTermRssFormatter

Same name and namespace in other branches
  1. 11.x core/modules/taxonomy/src/Plugin/Field/FieldFormatter/EntityReferenceTaxonomyTermRssFormatter.php \Drupal\taxonomy\Plugin\Field\FieldFormatter\EntityReferenceTaxonomyTermRssFormatter

Plugin implementation of the 'entity reference taxonomy term RSS' formatter.

Plugin annotation


@FieldFormatter(
  id = "entity_reference_rss_category",
  label = @Translation("RSS category"),
  description = @Translation("Display reference to taxonomy term in RSS."),
  field_types = {
    "entity_reference"
  }
)

Hierarchy

Expanded class hierarchy of EntityReferenceTaxonomyTermRssFormatter

File

core/modules/taxonomy/src/Plugin/Field/FieldFormatter/EntityReferenceTaxonomyTermRssFormatter.php, line 22

Namespace

Drupal\taxonomy\Plugin\Field\FieldFormatter
View source
class EntityReferenceTaxonomyTermRssFormatter extends EntityReferenceFormatterBase {
  
  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $parent_entity = $items->getEntity();
    $elements = [];
    foreach ($this->getEntitiesToView($items, $langcode) as $entity) {
      $parent_entity->rss_elements[] = [
        'key' => 'category',
        'value' => $entity->label(),
        'attributes' => [
          'domain' => $entity->id() ? Url::fromRoute('entity.taxonomy_term.canonical', [
            'taxonomy_term' => $entity->id(),
          ], [
            'absolute' => TRUE,
          ])
            ->toString() : '',
        ],
      ];
    }
    return $elements;
  }
  
  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    // This formatter is only available for taxonomy terms.
    return $field_definition->getFieldStorageDefinition()
      ->getSetting('target_type') == 'taxonomy_term';
  }

}

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