class ButtonLinkFormatter in Button Link Formatter 8

Plugin implementation of the 'link_separate' formatter.

@todo https://www.drupal.org/node/1829202 Merge into 'link' formatter once there is a #type like 'item' that can render a compound label and content outside of a form context.

Plugin annotation


@FieldFormatter(
  id = "button_link",
  label = @Translation("Link as Button"),
  field_types = {
    "link"
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
    class \Drupal\link\Plugin\Field\FieldFormatter\LinkFormatter implements ContainerFactoryPluginInterface
    class \Drupal\button_link\Plugin\Field\FieldFormatter\ButtonLinkFormatter

Expanded class hierarchy of ButtonLinkFormatter

File

src/Plugin/Field/FieldFormatter/ButtonLinkFormatter.php, line 25

Namespace

Drupal\button_link\Plugin\Field\FieldFormatter

View source

class ButtonLinkFormatter extends LinkFormatter {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'trim_length' => 80,
      'rel' => '',
      'target' => '',
      'link_text' => '',
      'btn_type' => 'btn-default',
      'btn_size' => '',
      'btn_block' => NULL,
      'icon_class' => '',
      'disable_btn_role' => 0,
    ] + parent::defaultSettings();
  }
  public function settingsForm(array $parentForm, FormStateInterface $form_state) {
    $parentForm = parent::settingsForm($parentForm, $form_state);
    $settings = $this
      ->getSettings();
    $form['link_text'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Link text, leave empty for default'),
      '#default_value' => $settings['link_text'],
    ];
    $form['btn_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Button type'),
      '#default_value' => $settings['btn_type'],
      '#options' => [
        'btn-default' => $this
          ->t('Default'),
        'btn-primary' => $this
          ->t('Primary'),
        'btn-secondary' => $this
          ->t('Secondary'),
        'btn-success' => $this
          ->t('Success'),
        'btn-info' => $this
          ->t('Info'),
        'btn-warning' => $this
          ->t('Warning'),
        'btn-danger' => $this
          ->t('Danger'),
        'btn-light' => $this
          ->t('Light'),
        'btn-dark' => $this
          ->t('Dark'),
        'btn-link' => $this
          ->t('Link'),
      ],
      '#required' => TRUE,
    ];
    $form['btn_size'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Button size'),
      '#default_value' => $settings['btn_size'],
      '#empty_option' => $this
        ->t('Default'),
      '#options' => [
        'btn-lg' => $this
          ->t('Large'),
        'btn-sm' => $this
          ->t('Small'),
        'btn-xs' => $this
          ->t('Extra Small'),
      ],
    ];
    $form['icon_class'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Classes for icons, example: "fa fa-anchor".'),
      '#default_value' => $settings['icon_class'],
    ];
    $form['disable_btn_role'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t("Disable default role 'button'"),
      '#default_value' => $settings['disable_btn_role'],
    ];
    $form['btn_block'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Block level?'),
      '#return_value' => 'btn-block',
      '#default_value' => $settings['btn_block'],
    ];
    return $form + $parentForm;
  }
  public function settingsSummary() {
    $settings = $this
      ->getSettings();
    $summary[] = $this
      ->t('Button type: @text', [
      '@text' => $settings['btn_type'],
    ]);
    if (!empty($settings['btn_size'])) {
      $summary[] = $this
        ->t('Button size: @text', [
        '@text' => $settings['btn_size'],
      ]);
    }
    if (!empty($settings['link_text'])) {
      $summary[] = $this
        ->t('Link text: @text', [
        '@text' => $settings['link_text'],
      ]);
    }
    if (!empty($settings['rel'])) {
      $summary[] = $this
        ->t('Add rel="@rel"', [
        '@rel' => $settings['rel'],
      ]);
    }
    if (!empty($settings['btn_block'])) {
      $summary[] = $this
        ->t('Block level button: @text', [
        '@text' => $settings['btn_block'],
      ]);
    }
    if (!empty($settings['icon_class'])) {
      $summary[] = $this
        ->t('Icon class: "@rel"', [
        '@rel' => $settings['icon_class'],
      ]);
    }
    if (!empty($settings['target'])) {
      $summary[] = $this
        ->t('Open link in new window');
    }
    return $summary;
  }

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

      // By default use the full URL as the link text.
      $url = $this
        ->buildUrl($item);
      $link_title = $url
        ->toString();

      // 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 the entire link title
        // gets auto-escaped during link generation in
        // \Drupal\Core\Utility\LinkGenerator::generate().
        $link_title = \Drupal::token()
          ->replace($item->title, [
          $entity
            ->getEntityTypeId() => $entity,
        ], [
          'clear' => TRUE,
        ]);
      }
      if (!empty($settings['link_text'])) {
        $link_title = $this
          ->t($settings['link_text']);
      }

      // 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) && empty($settings['link_text'])) {
        $link_title = NULL;
      }
      $url_title = $url
        ->toString();
      if (!empty($settings['trim_length'])) {
        $link_title = Unicode::truncate($link_title, $settings['trim_length'], FALSE, TRUE);
        $url_title = Unicode::truncate($url_title, $settings['trim_length'], FALSE, TRUE);
      }
      $element[$delta] = array(
        '#theme' => 'link_formatter_button_link',
        '#title' => $link_title,
        '#url_title' => $url_title,
        '#url' => $url,
        '#type' => $settings['btn_type'],
        '#size' => $settings['btn_size'],
        '#block' => $settings['btn_block'],
        '#icon_class' => $settings['icon_class'],
      );
      if (!empty($item->_attributes)) {

        // Set our RDFa attributes on the <a> element that is being built.
        $url
          ->setOption('attributes', $item->_attributes);

        // Unset field item attributes since they have been included in the
        // formatter output and should not be rendered in the field template.
        unset($item->_attributes);
      }
    }
    return $element;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ButtonLinkFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides LinkFormatter::defaultSettings
ButtonLinkFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides LinkFormatter::settingsForm
ButtonLinkFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides LinkFormatter::settingsSummary
ButtonLinkFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides LinkFormatter::viewElements
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.
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.

You are here