You are here

Home » API reference » Social Link Field 8 » SocialLinkFontAwesomeFormatter.php

class SocialLinkFontAwesomeFormatter in Social Link Field 8

Plugin implementation of the 'social_link_field' formatter.

Plugin annotation


@FieldFormatter(
  id = "font_awesome",
  label = @Translation("FonAwesome icons"),
  field_types = {
    "social_links"
  }
)

Hierarchy

Expanded class hierarchy of SocialLinkFontAwesomeFormatter

File

src/Plugin/Field/FieldFormatter/SocialLinkFontAwesomeFormatter.php, line 19

Namespace

Drupal\social_link_field\Plugin\Field\FieldFormatter
View source 
class SocialLinkFontAwesomeFormatter extends SocialLinkBaseFormatter {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'icon_type' => 'common',
      'orientation' => 'vertical',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = parent::settingsForm($form, $form_state);
    $element['icon_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Select icon type'),
      '#options' => [
        'common' => $this
          ->t('Common icon'),
        'square' => $this
          ->t('Square icon'),
      ],
      '#default_value' => $this
        ->getSetting('icon_type'),
    ];
    $element['orientation'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Orientation'),
      '#options' => [
        'vertical' => $this
          ->t('Vertical'),
        'horizontal' => $this
          ->t('Horizontal'),
      ],
      '#default_value' => $this
        ->getSetting('orientation'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $element = parent::viewElements($items, $langcode);
    $configs = $this->configFactory
      ->get('social_link_field.settings');
    $icon_type = $this
      ->getSetting('icon_type');
    $element['#appearance'] = [
      'orientation' => $this
        ->getSetting('orientation'),
    ];
    foreach ($items as $delta => $item) {
      $values = $item
        ->getValue();
      $social = $values['social'];
      $link = $values['link'];
      if ($icon_type == 'square' && isset($this->platforms[$social]['iconSquare'])) {
        $icon = $this->platforms[$social]['iconSquare'];
      }
      else {
        $icon = $this->platforms[$social]['icon'];
      }
      $element['#links'][$delta] = [
        'text' => [
          '#type' => 'html_tag',
          '#tag' => 'i',
          '#attributes' => [
            'class' => [
              'fa',
              $icon,
            ],
          ],
        ],
        'url' => $this->platforms[$social]['urlPrefix'] . $link,
        'title' => $this->platforms[$social]['name'],
      ];
    }

    // Attach formatter library.
    $element['#attached']['library'][] = 'social_link_field/social_link_field.font_awesome_formatter';

    // Attach FontAwesome external library.
    if ($configs
      ->get('attached_fa')) {
      $element['#attached']['library'][] = 'social_link_field/fontawesome.component';
    }
    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::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterInterface::settingsSummary 22
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
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
SocialLinkBaseFormatter::$configFactory protected property The config factory.
SocialLinkBaseFormatter::$platforms protected property Platform of social networks.
SocialLinkBaseFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
SocialLinkBaseFormatter::__construct public function Constructs a FormatterBase object. Overrides FormatterBase::__construct
SocialLinkFontAwesomeFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides SocialLinkBaseFormatter::defaultSettings
SocialLinkFontAwesomeFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides SocialLinkBaseFormatter::settingsForm
SocialLinkFontAwesomeFormatter::viewElements public function Builds a renderable array for a field value. Overrides SocialLinkBaseFormatter::viewElements
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.