class EntityReferenceTaxonomyTermRssFormatter

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

@todo: Have a way to indicate this formatter applies only to taxonomy terms.

Plugin annotation


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

Hierarchy

Expanded class hierarchy of EntityReferenceTaxonomyTermRssFormatter

File

drupal/core/modules/taxonomy/lib/Drupal/taxonomy/Plugin/field/formatter/EntityReferenceTaxonomyTermRssFormatter.php, line 30
Contains \Drupal\taxonomy\Plugin\field\formatter\EntityReferenceTaxonomyTermRssFormatter.

Namespace

Drupal\taxonomy\Plugin\field\formatter
View source
class EntityReferenceTaxonomyTermRssFormatter extends EntityReferenceFormatterBase {

  /**
   * Overrides Drupal\entity_reference\Plugin\field\formatter\EntityReferenceFormatterBase::viewElements().
   */
  public function viewElements(EntityInterface $entity, $langcode, array $items) {
    $elements = array();
    foreach ($items as $delta => $item) {
      $entity->rss_elements[] = array(
        'key' => 'category',
        'value' => $item['entity']
          ->label(),
        'attributes' => array(
          'domain' => $item['target_id'] ? url('taxonomy/term/' . $item['target_id'], array(
            'absolute' => TRUE,
          )) : '',
        ),
      );
    }
    return $elements;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
EntityReferenceFormatterBase::prepareView public function Overrides \Drupal\field\Plugin\Type\Formatter\FormatterBase::prepareView(). Overrides FormatterBase::prepareView
EntityReferenceTaxonomyTermRssFormatter::viewElements public function Overrides Drupal\entity_reference\Plugin\field\formatter\EntityReferenceFormatterBase::viewElements(). Overrides EntityReferenceFormatterBase::viewElements
FormatterBase::$field protected property The field definition.
FormatterBase::$instance protected property The field instance 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::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterInterface::settingsForm 12
FormatterBase::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterInterface::settingsSummary 12
FormatterBase::view public function Builds a renderable array for one field on one entity instance. Overrides FormatterInterface::view
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::getPluginDefinition public function Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::getDefaultSettings public function Implements Drupal\field\Plugin\PluginSettingsInterface::getDefaultSettings(). Overrides PluginSettingsInterface::getDefaultSettings
PluginSettingsBase::getSetting public function Implements Drupal\field\Plugin\PluginSettingsInterface::getSetting(). Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Implements Drupal\field\Plugin\PluginSettingsInterface::getSettings(). Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::setSetting public function Implements Drupal\field\Plugin\PluginSettingsInterface::setSetting(). Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Implements Drupal\field\Plugin\PluginSettingsInterface::setSettings(). Overrides PluginSettingsInterface::setSettings