You are here

Home » API reference » Micon 8 » MiconLinkFormatter.php

class MiconLinkFormatter in Micon 8

Same name and namespace in other branches
  1. 2.x micon_link/src/Plugin/Field/FieldFormatter/MiconLinkFormatter.php \Drupal\micon_link\Plugin\Field\FieldFormatter\MiconLinkFormatter

Plugin implementation of the 'micon_link' formatter.

Plugin annotation


@FieldFormatter(
  id = "micon_link",
  label = @Translation("Link (with icon)"),
  field_types = {
    "link"
  }
)

Hierarchy

Expanded class hierarchy of MiconLinkFormatter

File

micon_link/src/Plugin/Field/FieldFormatter/MiconLinkFormatter.php, line 25

Namespace

Drupal\micon_link\Plugin\Field\FieldFormatter
View source 
class MiconLinkFormatter extends LinkFormatter {
  use MiconIconizeTrait;

  /**
   * The token service.
   *
   * @var \Drupal\Core\Utility\Token
   */
  protected $token;

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

  /**
   * {@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('token'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'title' => '',
      'icon' => '',
      'position' => 'before',
      'text_only' => '',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $settings = $this
      ->getSettings();
    if (!empty($settings['title'])) {
      $summary[] = t('Link title as @title', [
        '@title' => $settings['title'],
      ]);
    }
    if (!empty($settings['icon'])) {
      $summary[] = $this
        ->micon('Icon as')
        ->setIcon($settings['icon'])
        ->setIconAfter();
    }
    if (!empty($settings['position'])) {
      $summary[] = t('Icon position: @value', [
        '@value' => ucfirst($settings['position']),
      ]);
    }
    if (!empty($settings['trim_length'])) {
      $summary[] = t('Link text trimmed to @limit characters', [
        '@limit' => $settings['trim_length'],
      ]);
    }
    else {
      $summary[] = t('Link text not trimmed');
    }
    if (!empty($settings['text_only'])) {
      $summary[] = t('Text only');
    }
    else {
      if (!empty($settings['rel'])) {
        $summary[] = t('Add rel="@rel"', [
          '@rel' => $settings['rel'],
        ]);
      }
      if (!empty($settings['target'])) {
        $summary[] = t('Open link in new window');
      }
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);
    $elements['title'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Link title'),
      '#default_value' => $this
        ->getSetting('title'),
      '#description' => $this
        ->t('Will be used as the link title unless one has been set on the field. Supports token replacement.'),
      '#weight' => -10,
    ];
    $elements['text_only'] = [
      '#type' => 'checkbox',
      '#title' => t('Text only'),
      '#default_value' => $this
        ->getSetting('text_only'),
      '#weight' => -10,
    ];
    $elements['icon'] = [
      '#type' => 'micon',
      '#title' => $this
        ->t('Link icon'),
      '#default_value' => $this
        ->getSetting('icon'),
      '#description' => $this
        ->t('Will be used as the link icon even if one has been set on the field.'),
      '#weight' => -10,
    ];
    $elements['position'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Icon position'),
      '#options' => [
        'before' => $this
          ->t('Before'),
        'after' => $this
          ->t('After'),
      ],
      '#default_value' => $this
        ->getSetting('position'),
      '#required' => TRUE,
      '#weight' => -10,
    ];
    $visibility = [
      'invisible' => [
        ':input[name*="text_only"]' => [
          'checked' => TRUE,
        ],
      ],
    ];
    $elements['rel']['#states'] = $visibility;
    $elements['target']['#states'] = $visibility;
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $element = parent::viewElements($items, $langcode);
    $entity = $items
      ->getEntity();
    $entity_type = $entity
      ->getEntityTypeId();
    $title = $this
      ->getSetting('title');
    $default_position = $this
      ->getSetting('position');
    $text_only = $this
      ->getSetting('text_only');
    foreach ($element as $delta => &$item) {
      $icon = $this
        ->getSetting('icon');
      if ($title && empty($items[$delta]->title)) {
        $item['#title'] = $this->token
          ->replace($title, [
          $entity_type => $entity,
        ]);
      }
      if (!$icon && !empty($item['#options']['attributes']['data-icon'])) {
        $icon = $item['#options']['attributes']['data-icon'];
      }
      if ($icon) {
        $position = !empty($item['#options']['attributes']['data-icon-position']) ? $item['#options']['attributes']['data-icon-position'] : $default_position;
        $micon = $this
          ->micon($item['#title'])
          ->setIcon($icon);
        if ($position == 'after') {
          $micon
            ->setIconAfter();
        }
        $item['#title'] = $micon;
        unset($item['#options']['attributes']['data-icon']);
      }
      if ($text_only) {
        $item = [
          '#markup' => $item['#title'],
        ];
      }
    }
    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::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
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.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
MiconIconizeTrait::getMiconStringTranslation protected function Gets the string translation service.
MiconIconizeTrait::micon protected function Transforms a string into an icon + string.
MiconIconizeTrait::setMiconStringTranslation public function Sets the string translation service to use.
MiconLinkFormatter::$token protected property The token service.
MiconLinkFormatter::create public static function Creates an instance of the plugin. Overrides LinkFormatter::create
MiconLinkFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides LinkFormatter::defaultSettings
MiconLinkFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides LinkFormatter::settingsForm
MiconLinkFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides LinkFormatter::settingsSummary
MiconLinkFormatter::viewElements public function Builds a renderable array for a field value. Overrides LinkFormatter::viewElements
MiconLinkFormatter::__construct public function Constructs a new LinkFormatter. Overrides LinkFormatter::__construct
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.