class LinkSeparateFormatter

Plugin implementation of the 'link_separate' formatter.

Plugin annotation


@FieldFormatter(
  id = "link_separate",
  module = "link",
  label = @Translation("Separate link text and URL"),
  field_types = {
    "link"
  },
  settings = {
    "trim_length" = "80",
    "rel" = "",
    "target" = ""
  }
)

Hierarchy

Expanded class hierarchy of LinkSeparateFormatter

File

drupal/core/modules/link/lib/Drupal/link/Plugin/field/formatter/LinkSeparateFormatter.php, line 37
Contains \Drupal\link\Plugin\field\formatter\LinkSeparateFormatter.

Namespace

Drupal\link\Plugin\field\formatter
View source
class LinkSeparateFormatter extends LinkFormatter {

  /**
   * {@inheritdoc}
   */
  public function viewElements(EntityInterface $entity, $langcode, array $items) {
    $element = array();
    $settings = $this
      ->getSettings();
    foreach ($items as $delta => $item) {

      // By default use the full URL as the link text.
      $link_title = $item['url'];

      // If the link text field value is available, use it for the text.
      if (empty($settings['url_only']) && !empty($item['title'])) {

        // Unsanitized token replacement here because $options['html'] is FALSE
        // by default in theme_link().
        $link_title = \Drupal::token()
          ->replace($item['title'], array(
          $entity
            ->entityType() => $entity,
        ), array(
          'sanitize' => FALSE,
          'clear' => TRUE,
        ));
      }

      // The link_separate formatter has two titles; the link text (as in the
      // field values) and the URL itself. If there is no link text value,
      // $link_title defaults to the URL, so it needs to be unset.
      // The URL version may need to be trimmed as well.
      if (empty($item['title'])) {
        $link_title = NULL;
      }
      $url_title = $item['url'];
      if (!empty($settings['trim_length'])) {
        $link_title = truncate_utf8($link_title, $settings['trim_length'], FALSE, TRUE);
        $url_title = truncate_utf8($item['url'], $settings['trim_length'], FALSE, TRUE);
      }
      $element[$delta] = array(
        '#theme' => 'link_formatter_link_separate',
        '#title' => $link_title,
        '#url_title' => $url_title,
        '#href' => $item['path'],
        '#options' => $item['options'],
      );
    }
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::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
LinkFormatter::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterBase::prepareView
LinkFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
LinkFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
LinkSeparateFormatter::viewElements public function Builds a renderable array for a field value. Overrides LinkFormatter::viewElements
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