class EntityReferenceLabelFormatter

Same name in other branches
  1. 9 core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/EntityReferenceLabelFormatter.php \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceLabelFormatter
  2. 10 core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/EntityReferenceLabelFormatter.php \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceLabelFormatter
  3. 11.x core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/EntityReferenceLabelFormatter.php \Drupal\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceLabelFormatter

Plugin implementation of the 'entity reference label' formatter.

Plugin annotation


@FieldFormatter(
  id = "entity_reference_label",
  label = @Translation("Label"),
  description = @Translation("Display the label of the referenced entities."),
  field_types = {
    "entity_reference"
  }
)

Hierarchy

Expanded class hierarchy of EntityReferenceLabelFormatter

File

core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/EntityReferenceLabelFormatter.php, line 22

Namespace

Drupal\Core\Field\Plugin\Field\FieldFormatter
View source
class EntityReferenceLabelFormatter extends EntityReferenceFormatterBase {
    
    /**
     * {@inheritdoc}
     */
    public static function defaultSettings() {
        return [
            'link' => TRUE,
        ] + parent::defaultSettings();
    }
    
    /**
     * {@inheritdoc}
     */
    public function settingsForm(array $form, FormStateInterface $form_state) {
        $elements['link'] = [
            '#title' => t('Link label to the referenced entity'),
            '#type' => 'checkbox',
            '#default_value' => $this->getSetting('link'),
        ];
        return $elements;
    }
    
    /**
     * {@inheritdoc}
     */
    public function settingsSummary() {
        $summary = [];
        $summary[] = $this->getSetting('link') ? t('Link to the referenced entity') : t('No link');
        return $summary;
    }
    
    /**
     * {@inheritdoc}
     */
    public function viewElements(FieldItemListInterface $items, $langcode) {
        $elements = [];
        $output_as_link = $this->getSetting('link');
        foreach ($this->getEntitiesToView($items, $langcode) as $delta => $entity) {
            $label = $entity->label();
            // If the link is to be displayed and the entity has a uri, display a
            // link.
            if ($output_as_link && !$entity->isNew()) {
                try {
                    $uri = $entity->toUrl();
                } catch (UndefinedLinkTemplateException $e) {
                    // This exception is thrown by \Drupal\Core\Entity\Entity::urlInfo()
                    // and it means that the entity type doesn't have a link template nor
                    // a valid "uri_callback", so don't bother trying to output a link for
                    // the rest of the referenced entities.
                    $output_as_link = FALSE;
                }
            }
            if ($output_as_link && isset($uri) && !$entity->isNew()) {
                $elements[$delta] = [
                    '#type' => 'link',
                    '#title' => $label,
                    '#url' => $uri,
                    '#options' => $uri->getOptions(),
                ];
                if (!empty($items[$delta]->_attributes)) {
                    $elements[$delta]['#options'] += [
                        'attributes' => [],
                    ];
                    $elements[$delta]['#options']['attributes'] += $items[$delta]->_attributes;
                    // Unset field item attributes since they have been included in the
                    // formatter output and shouldn't be rendered in the field template.
                    unset($items[$delta]->_attributes);
                }
            }
            else {
                $elements[$delta] = [
                    '#plain_text' => $label,
                ];
            }
            $elements[$delta]['#cache']['tags'] = $entity->getCacheTags();
        }
        return $elements;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function checkAccess(EntityInterface $entity) {
        return $entity->access('view label', NULL, TRUE);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
EntityReferenceFormatterBase::getEntitiesToView protected function Returns the referenced entities for display. 1
EntityReferenceFormatterBase::needsEntityLoad protected function Returns whether the entity referenced by an item needs to be loaded. 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
EntityReferenceLabelFormatter::checkAccess protected function Checks access to the given entity. Overrides EntityReferenceFormatterBase::checkAccess
EntityReferenceLabelFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
EntityReferenceLabelFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
EntityReferenceLabelFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
EntityReferenceLabelFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
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 Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
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 Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::__construct public function Constructs a FormatterBase object. 11
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 Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting

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