You are here

Home » API reference » Link Icon 8 » LinkIconFormatter.php

class LinkIconFormatter in Link Icon 8

Plugin implementation of the 'linkicon' formatter.

Plugin annotation


@FieldFormatter(
  id = "linkicon",
  label = @Translation("Link icon, based on title"),
  field_types = {
    "link"
  }
)

Hierarchy

Expanded class hierarchy of LinkIconFormatter

File

src/Plugin/Field/FieldFormatter/LinkIconFormatter.php, line 26

Namespace

Drupal\linkicon\Plugin\Field\FieldFormatter
View source 
class LinkIconFormatter extends LinkFormatter {
  use LinkIconFormatterTrait;

  /**
   * The renderer.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * The linkicon service.
   *
   * @var \Drupal\linkicon\LinkIconManagerInterface
   */
  protected $linkIconManager;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('path.validator'), $container
      ->get('renderer'), $container
      ->get('linkicon.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, PathValidatorInterface $path_validator, RendererInterface $renderer, LinkIconManagerInterface $linkicon_manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings, $path_validator);
    $this->renderer = $renderer;
    $this->linkIconManager = $linkicon_manager;
  }

  /**
   * {@inheritdoc}
   */
  public function prepareView(array $entities_items) {

    // @todo drop 'predefined' for the new integer: LINKICON_PREDEFINED.
    if ($this
      ->getFieldSetting('title') == LinkIconManagerInterface::LINKICON_PREDEFINED || $this
      ->getFieldSetting('title') == 'predefined') {
      $settings = $this
        ->getFieldSettings();
      if (!empty($settings['title_predefined'])) {
        $titles = $this->linkIconManager
          ->extractAllowedValues($settings['title_predefined']);
        $tooltips = $this->linkIconManager
          ->extractAllowedValues($settings['title_predefined'], TRUE);
        foreach ($entities_items as $items) {
          $new_values = [];
          foreach ($items as $item) {
            $values = $item
              ->getValue();
            $title = isset($values['title']) ? $values['title'] : 'nix';
            $new_values['display_title'] = isset($titles[$title]) ? $titles[$title] : '';
            if (isset($tooltips[$title]) && $tooltips[$title]) {
              $new_values['tooltip'] = $tooltips[$title];
            }
            $merged_values = array_merge($values, $new_values);
            $item
              ->setValue($merged_values);
          }
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $element = $contents = [];
    $entity = $items
      ->getEntity();
    $entity_type = $entity
      ->getEntityTypeId();
    $bundle = $entity
      ->bundle();
    $id = $entity
      ->id();
    $field_name = $this->fieldDefinition
      ->getName();
    $language = \Drupal::languageManager()
      ->getCurrentLanguage();
    $config = $this->linkIconManager
      ->simplifySettings($this
      ->getSettings());
    foreach ($items as $delta => $item) {
      $attributes = [
        'class' => [
          'linkicon__item',
        ],
      ];
      $prefix_class = Html::escape($config['prefix']);

      // Linkicon requires both link text and URL available with proper
      // validation during input, no need extra checks.
      $icon_name = $item->title;
      $display_title = isset($item->display_title) ? $item->display_title : $icon_name;
      $tooltip = isset($item->tooltip) ? $item->tooltip : $display_title;
      $icon_class = Html::cleanCssIdentifier(mb_strtolower($prefix_class . '-' . $icon_name));

      // If title is overriden with a generic one, be sure the $icon_class is
      // not overridden.
      if (!empty($config['global_title']) && empty($config['no_text'])) {
        $display_title = $config['global_title'];
      }

      // The link title/content.
      // Tokenized text is sanitized by default, the rest is twig-autoescaped,
      // see #2296163.
      $token = \Drupal::token();
      $display_title = $token
        ->replace($display_title, [
        $entity_type => $entity,
      ], [
        'langcode' => $language
          ->getId(),
      ]);
      $tooltip = $token
        ->replace($tooltip, [
        $entity_type => $entity,
      ], [
        'langcode' => $language
          ->getId(),
      ]);
      $maxlength = $config['maxlength'] ?: 60;
      $icon_element = [
        '#theme' => 'linkicon_item',
        '#title' => Unicode::truncate($display_title, $maxlength, TRUE, TRUE),
        '#icon_name' => $icon_name,
        '#settings' => $config,
      ];

      // The link/A tag.
      $url = $this
        ->buildUrl($item);
      $options = $url
        ->getOptions();

      // Without icon, displaying title only.
      if (!empty($config['link'])) {
        $attributes['class'][] = $prefix_class;
        $attributes['class'][] = $icon_class;
      }

      // Our pure CSS3 tooltip depends on data-title.
      if ($config['tooltip']) {
        $attributes['data-title'] = Unicode::truncate($tooltip, $maxlength, TRUE, TRUE);
      }

      // Merge with core options: rel and target.
      if (isset($options['attributes']) && $options['attributes']) {
        $options['attributes'] += $attributes;
      }
      else {
        $options['attributes'] = $attributes;
      }

      // We are done, pass it over to link to do its job.
      // @todo https://www.drupal.org/node/2350519
      // No need to SafeMarkup $icon_element, as all is already sanitized above.
      $contents[$delta] = [
        '#type' => 'link',
        '#title' => $icon_element,
        '#url' => $url,
        '#options' => $options,
      ];
    }

    // The UL and item-list DIV wrapper tags.
    // Build own wrapper for greater control.
    if ($contents) {
      $linkicon_id = Html::cleanCssIdentifier("{$entity_type}-{$bundle}-{$field_name}-{$id}");
      $element = [
        '#theme' => 'linkicon',
        '#linkicon_id' => 'linkicon-' . $linkicon_id,
        '#items' => $contents,
        '#config' => $config,
      ];

      // Attached our assets if so configured.
      if ($this->linkIconManager
        ->getSetting('font')) {
        $element['#attached']['library'][] = 'linkicon/linkicon.font';
      }
      if ($config['load']) {
        $element['#attached']['library'][] = 'linkicon/linkicon';
      }
      $info = [
        '#title' => $this->fieldDefinition
          ->getLabel(),
        '#label_display' => $this->label,
        '#view_mode' => $this->viewMode,
        '#language' => $items
          ->getLangcode(),
        '#field_name' => $field_name,
        '#field_type' => $this->fieldDefinition
          ->getType(),
        '#field_translatable' => $this->fieldDefinition
          ->isTranslatable(),
        '#entity_type' => $entity_type,
        '#bundle' => $bundle,
        '#is_multiple' => $this->fieldDefinition
          ->getFieldStorageDefinition()
          ->isMultiple(),
      ];
      $element = array_merge($info, $element);
    }
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
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::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::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
LinkFormatter::$pathValidator protected property The path validator service.
LinkFormatter::buildUrl protected function Builds the \Drupal\Core\Url object for a link field item.
LinkIconFormatter::$linkIconManager protected property The linkicon service.
LinkIconFormatter::$renderer protected property The renderer.
LinkIconFormatter::create public static function Creates an instance of the plugin. Overrides LinkFormatter::create
LinkIconFormatter::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterBase::prepareView
LinkIconFormatter::viewElements public function Builds a renderable array for a field value. Overrides LinkFormatter::viewElements
LinkIconFormatter::__construct public function Constructs a new LinkFormatter. Overrides LinkFormatter::__construct
LinkIconFormatterTrait::defaultSettings public static function
LinkIconFormatterTrait::settingsForm public function
LinkIconFormatterTrait::settingsSummary public function
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
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
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.