123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111 |
- <?php
- namespace Drupal\Core\Field\Plugin\Field\FieldFormatter;
- use Drupal\Core\Entity\EntityInterface;
- use Drupal\Core\Entity\Exception\UndefinedLinkTemplateException;
- use Drupal\Core\Field\FieldItemListInterface;
- use Drupal\Core\Form\FormStateInterface;
- /**
- * Plugin implementation of the 'entity reference label' formatter.
- *
- * @FieldFormatter(
- * id = "entity_reference_label",
- * label = @Translation("Label"),
- * description = @Translation("Display the label of the referenced entities."),
- * field_types = {
- * "entity_reference"
- * }
- * )
- */
- 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->urlInfo();
- }
- 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);
- }
- }
|