You are here

Home » API reference » Element Class Formatter 8 » LinkAllyFormatter.php

class LinkAllyFormatter in Element Class Formatter 8

Defines a formatter that allows links with screenreader only text.

Plugin annotation


@FieldFormatter(
  id = "link_ally_class",
  label = @Translation("Link (with screenreader text)"),
  field_types = {
    "link",
    "string",
  }
)

Hierarchy

Expanded class hierarchy of LinkAllyFormatter

File

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

Namespace

Drupal\element_class_formatter\Plugin\Field\FieldFormatter
View source 
class LinkAllyFormatter extends FormatterBase {

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

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

    /** @var self $instance */
    $instance = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    $instance->token = $container
      ->get('token');
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $default_settings = parent::defaultSettings() + [
      'link_text' => '',
      'screenreader_text' => '',
      'tag' => '',
    ];
    return ElementClassTrait::elementClassDefaultSettings($default_settings);
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);
    $elements['link_text'] = [
      '#title' => $this
        ->t('Link text'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('link_text'),
      '#description' => $this
        ->t('Custom link text - leave empty to use the field value.'),
    ];
    $elements['screenreader_text'] = [
      '#title' => $this
        ->t('Screenreader text'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('screenreader_text'),
      '#description' => $this
        ->t('Screenreader text - tokens are available.'),
    ];
    $class = $this
      ->getSetting('class');
    $wrapper_options = [
      'span' => 'span',
      'div' => 'div',
      'p' => 'p',
    ];
    foreach (range(1, 5) as $level) {
      $wrapper_options['h' . $level] = 'H' . $level;
    }
    $elements['tag'] = [
      '#title' => $this
        ->t('Tag'),
      '#type' => 'select',
      '#description' => $this
        ->t('Select an optional tag that will be wrapped around the link.'),
      '#options' => $wrapper_options,
      '#default_value' => $this
        ->getSetting('tag'),
      '#empty_value' => '',
      '#empty_option' => $this
        ->t('None'),
    ];
    return $this
      ->elementClassSettingsForm($elements, $class);
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $class = $this
      ->getSetting('class');
    if ($link_text = $this
      ->getSetting('link_text')) {
      $summary[] = $this
        ->t('Link text: @text', [
        '@text' => $link_text,
      ]);
    }
    if ($screenreader_text = $this
      ->getSetting('screenreader_text')) {
      $summary[] = $this
        ->t('Screenreader text: @text', [
        '@text' => $screenreader_text,
      ]);
    }
    if ($tag = $this
      ->getSetting('tag')) {
      $summary[] = $this
        ->t('Tag: @tag', [
        '@tag' => $tag,
      ]);
    }
    return $this
      ->elementClassSettingsSummary($summary, $class);
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $build = [];
    $entity = $items
      ->getEntity();
    $custom_link_text = $this
      ->getSetting('link_text');
    $cache = new BubbleableMetadata();
    $screenreader_text = trim($this->token
      ->replace($this
      ->getSetting('screenreader_text'), [
      $entity
        ->getEntityTypeId() => $entity,
    ], [], $cache));
    if ($screenreader_text) {
      $screenreader_text = [
        '#type' => 'inline_template',
        '#template' => '<span class="visually-hidden">{{screenreader_text}}</span>',
        '#context' => [
          'screenreader_text' => [
            '#markup' => $screenreader_text,
          ],
        ],
      ];
    }
    foreach ($items as $delta => $item) {
      $label = $items
        ->getFieldDefinition()
        ->getType() === 'link' ? $item->title : $item->value;
      $uri = $items
        ->getFieldDefinition()
        ->getType() === 'link' ? $item
        ->getUrl() ?: Url::fromRoute('<none>') : $entity
        ->toUrl('canonical');
      if ($custom_link_text) {
        $label = $custom_link_text;
      }
      if ($screenreader_text) {
        $label = [
          [
            '#plain_text' => $label,
          ],
          $screenreader_text,
        ];
      }
      $build[$delta] = [
        '#type' => 'link',
        '#title' => $label,
        '#url' => $uri,
        '#options' => $uri
          ->getOptions(),
      ];
    }
    $cache
      ->applyTo($build);
    $build = $this
      ->setElementClass($build, $this
      ->getSetting('class'), $items);
    if ($tag = $this
      ->getSetting('tag')) {
      foreach (Element::children($build) as $delta) {
        $build[$delta] = [
          '#type' => 'inline_template',
          '#template' => '<{{tag}}>{{element}}</{{tag}}>',
          '#context' => [
            'tag' => $tag,
            'element' => $build[$delta],
          ],
        ];
      }
    }
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    $manager = \Drupal::entityTypeManager();
    $type_id = $field_definition
      ->getTargetEntityTypeId();

    // Either this is a link field, or this is an entity-type that has a
    // canonical route.
    return parent::isApplicable($field_definition) && ($field_definition
      ->getType() === 'link' || $manager
      ->hasDefinition($type_id) && ($type = $manager
      ->getDefinition($type_id)) && $type
      ->hasLinkTemplate('canonical'));
  }

}

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
ElementClassTrait::elementClassDefaultSettings public static function Default class value.
ElementClassTrait::elementClassSettingsForm public function Setting form to collect class value.
ElementClassTrait::elementClassSettingsSummary public function Text for settings summary.
ElementClassTrait::setElementClass public function Set the class on the element.
ElementClassTrait::setEntityClass public function Set the class on the entity.
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::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
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 11
LinkAllyFormatter::$token protected property Token service.
LinkAllyFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
LinkAllyFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
LinkAllyFormatter::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
LinkAllyFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
LinkAllyFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
LinkAllyFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
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.