You are here

Home » API reference » Micon 8 » MiconLinkWidget.php

class MiconLinkWidget in Micon 8

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

Plugin implementation of the 'link' widget.

Plugin annotation


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

Hierarchy

Expanded class hierarchy of MiconLinkWidget

1 file declares its use of MiconLinkWidget
MiconMenuWidget.php in micon_menu/src/Plugin/Field/FieldWidget/MiconMenuWidget.php

File

micon_link/src/Plugin/Field/FieldWidget/MiconLinkWidget.php, line 23

Namespace

Drupal\micon_link\Plugin\Field\FieldWidget
View source 
class MiconLinkWidget extends LinkWidget {
  use MiconIconizeTrait;

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'placeholder_url' => '',
      'placeholder_title' => '',
      'target' => FALSE,
      'packages' => [],
      'icon' => '',
      'position' => FALSE,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = parent::settingsForm($form, $form_state);
    $element['packages'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Icon Packages'),
      '#default_value' => $this
        ->getSetting('packages'),
      '#description' => t('The icon packages that should be made available in this field. If no packages are selected, all will be made available.'),
      '#options' => Micon::loadActiveLabels(),
    ];
    $element['icon'] = [
      '#type' => 'micon',
      '#title' => $this
        ->t('Default Icon'),
      '#default_value' => $this
        ->getSetting('icon'),
    ];
    $element['position'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow icon position selection'),
      '#description' => $this
        ->t('If selected, a "position" select will be made available.'),
      '#default_value' => $this
        ->getSetting('position'),
    ];
    $element['target'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Allow target selection'),
      '#description' => $this
        ->t('If selected, an "open in new window" checkbox will be made available.'),
      '#default_value' => $this
        ->getSetting('target'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $element = parent::formElement($items, $delta, $element, $form, $form_state);
    $element['#element_validate'][] = [
      get_called_class(),
      'validateElement',
    ];
    $element['title']['#weight'] = -1;
    $id = Html::getUniqueId('micon-link-' . $this->fieldDefinition
      ->getName() . '-icon');
    $item = $items[$delta];
    $options = $item
      ->get('options')
      ->getValue();
    $attributes = isset($options['attributes']) ? $options['attributes'] : [];
    $element['options']['attributes']['data-icon'] = [
      '#type' => 'micon',
      '#title' => $this
        ->t('Icon'),
      '#id' => $id,
      '#default_value' => isset($attributes['data-icon']) ? $attributes['data-icon'] : $this
        ->getSetting('icon'),
      '#packages' => $this
        ->getPackages(),
    ];
    $element['options']['attributes']['data-icon-position'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Icon position'),
      '#options' => [
        'before' => $this
          ->t('Before'),
        'after' => $this
          ->t('After'),
      ],
      '#default_value' => isset($attributes['data-icon-position']) ? $attributes['data-icon-position'] : NULL,
      '#states' => [
        'invisible' => [
          '#' . $id => [
            'value' => '',
          ],
        ],
        'optional' => [
          '#' . $id => [
            'value' => '',
          ],
        ],
      ],
    ];
    if ($this
      ->getSetting('target')) {
      $element['options']['attributes']['target'] = [
        '#type' => 'checkbox',
        '#title' => t('Open link in new window'),
        '#description' => t('If selected, the menu link will open in a new window/tab when clicked.'),
        '#default_value' => !empty($attributes['target']),
        '#return_value' => '_blank',
      ];
    }
    return $element;
  }

  /**
   * Get packages available to this field.
   */
  protected function getPackages() {
    return $this
      ->getSetting('packages');
  }

  /**
   * Recursively clean up options array if no data-icon is set.
   */
  public static function validateElement($element, FormStateInterface $form_state, $form) {
    $values = $form_state
      ->getValue($element['#parents']);
    if (!empty($values)) {
      foreach ($values['options']['attributes'] as $attribute => $value) {
        if (!empty($value)) {
          $values['options']['attributes'][$attribute] = $value;
          $values['attributes'][$attribute] = $value;
        }
        else {
          unset($values['options']['attributes'][$attribute]);
          unset($values['attributes'][$attribute]);
        }
      }
    }
    $form_state
      ->setValueForElement($element, $values);
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $enabled_packages = array_filter($this
      ->getSetting('packages'));
    if ($enabled_packages) {
      $enabled_packages = array_intersect_key(Micon::loadActiveLabels(), $enabled_packages);
      $summary[] = $this
        ->t('With icon packages: @packages', [
        '@packages' => implode(', ', $enabled_packages),
      ]);
    }
    else {
      $summary[] = $this
        ->t('With icon packages: @packages', [
        '@packages' => 'All',
      ]);
    }
    if ($icon = $this
      ->getSetting('icon')) {
      $summary[] = $this
        ->micon('Default icon: ')
        ->setIcon($icon)
        ->setIconAfter();
    }
    if ($this
      ->getSetting('target')) {
      $summary[] = $this
        ->t('Allow target selection');
    }
    return $summary;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AllowedTagsXssTrait::allowedTags public function Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags public function Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss public function Filters an HTML string to prevent XSS vulnerabilities.
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
LinkWidget::flagErrors public function Override the '%uri' message parameter, to ensure that 'internal:' URIs show a validation error message that doesn't mention that scheme. Overrides WidgetBase::flagErrors
LinkWidget::getUriAsDisplayableString protected static function Gets the URI without the 'internal:' or 'entity:' scheme.
LinkWidget::getUserEnteredStringAsUri protected static function Gets the user-entered string as a URI.
LinkWidget::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetBase::massageFormValues
LinkWidget::supportsExternalLinks protected function Indicates enabled support for link to external URLs.
LinkWidget::supportsInternalLinks protected function Indicates enabled support for link to routes.
LinkWidget::validateTitleElement public static function Form element validation handler for the 'title' element.
LinkWidget::validateTitleNoLink public static function Form element validation handler for the 'title' element.
LinkWidget::validateUriElement public static function Form element validation handler for the 'uri' element.
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.
MiconLinkWidget::defaultSettings public static function Defines the default settings for this plugin. Overrides LinkWidget::defaultSettings
MiconLinkWidget::formElement public function Returns the form for a single field widget. Overrides LinkWidget::formElement 1
MiconLinkWidget::getPackages protected function Get packages available to this field. 1
MiconLinkWidget::settingsForm public function Returns a form to configure settings for the widget. Overrides LinkWidget::settingsForm
MiconLinkWidget::settingsSummary public function Returns a short summary for the current widget settings. Overrides LinkWidget::settingsSummary
MiconLinkWidget::validateElement public static function Recursively clean up options array if no data-icon is set.
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.
WidgetBase::$fieldDefinition protected property The field definition.
WidgetBase::$settings protected property The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax public static function Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit public static function Submission handler for the "Add another item" button.
WidgetBase::afterBuild public static function After-build handler for field elements in a form.
WidgetBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 5
WidgetBase::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement 8
WidgetBase::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues 2
WidgetBase::form public function Creates a form element for a field. Overrides WidgetBaseInterface::form 3
WidgetBase::formMultipleElements protected function Special handling to create form elements for multiple values. 1
WidgetBase::formSingleElement protected function Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting protected function Returns the value of a field setting.
WidgetBase::getFieldSettings protected function Returns the array of field settings.
WidgetBase::getFilteredDescription protected function Returns the filtered field description.
WidgetBase::getWidgetState public static function Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents protected static function Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues protected function Returns whether the widget handles multiple values.
WidgetBase::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable 4
WidgetBase::isDefaultValueWidget protected function Returns whether the widget used for default value form.
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState
WidgetBase::__construct public function Constructs a WidgetBase object. Overrides PluginBase::__construct 5