You are here

Home » API reference » Fixed text link formatter 8 » FixedTextLink.php

class FixedTextLink in Fixed text link formatter 8

Plugin implementation of the 'link' formatter.

Plugin annotation


@FieldFormatter(
  id = "fixed_text_link",
  label = @Translation("Link with fixed text"),
  field_types = {
    "link"
  }
)

Hierarchy

Expanded class hierarchy of FixedTextLink

File

src/Plugin/Field/FieldFormatter/FixedTextLink.php, line 20

Namespace

Drupal\fixed_text_link_formatter\Plugin\Field\FieldFormatter
View source 
class FixedTextLink extends LinkFormatter {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return array(
      'trim_length' => '',
      'link_text' => 'View website',
      'link_class' => '',
      'allow_override' => FALSE,
    ) + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $parentForm, FormStateInterface $form_state) {
    $parentForm = parent::settingsForm($parentForm, $form_state);
    unset($parentForm['trim_length']);
    unset($parentForm['url_only']);
    unset($parentForm['url_plain']);
    $form['link_text'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Link text'),
      '#default_value' => $this
        ->getLinkText(),
      '#required' => TRUE,
    ];
    $form['link_class'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Link class'),
      '#default_value' => $this
        ->getLinkClass(),
      '#required' => FALSE,
    ];
    $form['allow_override'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t("Allow the title to be overridden"),
      '#default_value' => $this
        ->getSetting('allow_override'),
    ];
    return $form + $parentForm;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $settings = $this
      ->getSettings();
    $summary[] = $this
      ->t('Link text: @text', [
      '@text' => $this
        ->getLinkText(),
    ]);
    if (!empty($settings['link_class'])) {
      $summary[] = $this
        ->t('Link class: @text', [
        '@text' => $this
          ->getLinkClass(),
      ]);
    }
    if (!empty($settings['rel'])) {
      $summary[] = $this
        ->t('Add rel="@rel"', [
        '@rel' => $settings['rel'],
      ]);
    }
    if (!empty($settings['target'])) {
      $summary[] = $this
        ->t('Open link in new window');
    }
    if ($this
      ->getSetting('allow_override')) {
      $summary[] = $this
        ->t('Link text can be overridden');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {

    /** @var \Drupal\link\Plugin\Field\FieldType\LinkItem $item */
    foreach ($items as $item) {
      $allowOverride = (bool) $this
        ->getSetting('allow_override');
      $shouldOverride = $allowOverride && $item
        ->get('title')
        ->getString() === '';
      if (!$allowOverride || $shouldOverride) {
        $item
          ->set('title', $this
          ->getLinkText());
      }
    }
    $elements = parent::viewElements($items, $langcode);
    foreach ($elements as &$element) {
      $element['#options']['attributes']['class'][] = $this
        ->getLinkClass();
    }
    return $elements;
  }

  /**
   * @return mixed
   */
  private function getLinkText() {
    return $this
      ->getSettings()['link_text'];
  }

  /**
   * @return string
   */
  private function getLinkClass() {
    return $this
      ->getSettings()['link_class'];
  }

}

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
FixedTextLink::defaultSettings public static function Defines the default settings for this plugin. Overrides LinkFormatter::defaultSettings
FixedTextLink::getLinkClass private function
FixedTextLink::getLinkText private function
FixedTextLink::settingsForm public function Returns a form to configure settings for the formatter. Overrides LinkFormatter::settingsForm
FixedTextLink::settingsSummary public function Returns a short summary for the current formatter settings. Overrides LinkFormatter::settingsSummary
FixedTextLink::viewElements public function Builds a renderable array for a field value. Overrides LinkFormatter::viewElements
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.
LinkFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
LinkFormatter::__construct public function Constructs a new LinkFormatter. Overrides FormatterBase::__construct
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.