EntityLink.php

Same filename in this branch
  1. 10 core/modules/comment/src/Plugin/views/field/EntityLink.php
Same filename and directory in other branches
  1. 9 core/modules/views/src/Plugin/views/field/EntityLink.php
  2. 9 core/modules/comment/src/Plugin/views/field/EntityLink.php
  3. 8.9.x core/modules/views/src/Plugin/views/field/EntityLink.php
  4. 8.9.x core/modules/comment/src/Plugin/views/field/EntityLink.php
  5. 11.x core/modules/views/src/Plugin/views/field/EntityLink.php
  6. 11.x core/modules/comment/src/Plugin/views/field/EntityLink.php

Namespace

Drupal\views\Plugin\views\field

File

core/modules/views/src/Plugin/views/field/EntityLink.php

View source
<?php

namespace Drupal\views\Plugin\views\field;

use Drupal\Core\Form\FormStateInterface;
use Drupal\views\Attribute\ViewsField;
use Drupal\views\ResultRow;

/**
 * Field handler to present a link to an entity.
 *
 * @ingroup views_field_handlers
 */
class EntityLink extends LinkBase {
  
  /**
   * {@inheritdoc}
   */
  public function render(ResultRow $row) {
    return $this->getEntity($row) ? parent::render($row) : [];
  }
  
  /**
   * {@inheritdoc}
   */
  protected function renderLink(ResultRow $row) {
    if ($this->options['output_url_as_text']) {
      $url_info = $this->getUrlInfo($row);
      return $url_info ? $url_info->toString() : '';
    }
    return parent::renderLink($row);
  }
  
  /**
   * {@inheritdoc}
   */
  protected function getUrlInfo(ResultRow $row) {
    $template = $this->getEntityLinkTemplate();
    $entity = $this->getEntity($row);
    if ($entity === NULL) {
      return NULL;
    }
    if ($this->languageManager
      ->isMultilingual()) {
      $entity = $this->getEntityTranslationByRelationship($entity, $row);
    }
    return $entity->toUrl($template)
      ->setAbsolute($this->options['absolute']);
  }
  
  /**
   * Returns the entity link template name identifying the link route.
   *
   * @return string
   *   The link template name.
   */
  protected function getEntityLinkTemplate() {
    return 'canonical';
  }
  
  /**
   * {@inheritdoc}
   */
  protected function getDefaultLabel() {
    return $this->t('view');
  }
  
  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['output_url_as_text'] = [
      'default' => FALSE,
    ];
    $options['absolute'] = [
      'default' => FALSE,
    ];
    return $options;
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    $form['output_url_as_text'] = [
      '#type' => 'checkbox',
      '#title' => $this->t('Output the URL as text'),
      '#default_value' => $this->options['output_url_as_text'],
    ];
    $form['absolute'] = [
      '#type' => 'checkbox',
      '#title' => $this->t('Use absolute link (begins with "http://")'),
      '#default_value' => $this->options['absolute'],
      '#description' => $this->t('Enable this option to output an absolute link. Required if you want to use the path as a link destination.'),
    ];
    parent::buildOptionsForm($form, $form_state);
    // Only show the 'text' field if we don't want to output the raw URL.
    $form['text']['#states']['visible'][':input[name="options[output_url_as_text]"]'] = [
      'checked' => FALSE,
    ];
  }

}

Classes

Title Deprecated Summary
EntityLink Field handler to present a link to an entity.

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