You are here

Home » API reference » Link class 8 » LinkClassFieldWidget.php

class LinkClassFieldWidget in Link class 8

Same name and namespace in other branches
  1. 2.0.x src/Plugin/Field/FieldWidget/LinkClassFieldWidget.php \Drupal\link_class\Plugin\Field\FieldWidget\LinkClassFieldWidget

Plugin implementation of the 'link_class_field_widget' widget.

Plugin annotation


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

Hierarchy

Expanded class hierarchy of LinkClassFieldWidget

File

src/Plugin/Field/FieldWidget/LinkClassFieldWidget.php, line 20

Namespace

Drupal\link_class\Plugin\Field\FieldWidget
View source 
class LinkClassFieldWidget extends LinkWidget {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'link_class_mode' => 'manual',
      'link_class_force' => '',
      'link_class_select' => '',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = parent::settingsForm($form, $form_state);
    $field_name = $this->fieldDefinition
      ->getName();
    $element['link_class_mode'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Method for adding class'),
      '#options' => $this
        ->getModeOptions(),
      '#default_value' => $this
        ->getSetting('link_class_mode'),
      '#description' => $this
        ->t('Select the method you want to use for adding class.'),
    ];
    $element['link_class_force'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Link classes'),
      '#default_value' => $this
        ->getSetting('link_class_force'),
      '#description' => $this
        ->t('Set the classes to add on each link. Classes must be separated by a space.'),
      '#attributes' => [
        'placeholder' => 'btn btn-default',
      ],
      '#size' => '30',
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $field_name . '][settings_edit_form][settings][link_class_mode]"]' => [
            'value' => 'force_class',
          ],
        ],
      ],
    ];
    $element['link_class_select'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Define possibles classes'),
      '#default_value' => $this
        ->getSetting('link_class_select'),
      '#description' => $this
        ->selectClassDescription(),
      '#attributes' => [
        'placeholder' => 'btn btn-default|Default button' . PHP_EOL . 'btn btn-primary|Primary button',
      ],
      '#size' => '30',
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $field_name . '][settings_edit_form][settings][link_class_mode]"]' => [
            'value' => 'select_class',
          ],
        ],
      ],
    ];
    return $element;
  }

  /**
   * Return the description for the class select mode.
   */
  protected function selectClassDescription() {
    $description = '<p>' . t('The possible classes this link can have. Enter one value per line, in the format key|label.');
    $description .= '<br/>' . t('The key is the string which will be used as a class on a link. The label will be used on edit forms.');
    $description .= '<br/>' . t('If the key contains several classes, each class must be separated by a <strong>space</strong>.');
    $description .= '<br/>' . t('The label is optional: if a line contains a single string, it will be used as key and label.');
    $description .= '</p>';
    return $description;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $option = $this
      ->getSetting('link_class_mode');
    $summary[] = $this
      ->t('Mode: @link_class_mode', [
      '@link_class_mode' => $this
        ->getModeOptions($option),
    ]);
    if ($option == 'force_class') {
      $summary[] = $this
        ->t('Class(es) added: @link_class_force', [
        '@link_class_force' => $this
          ->getSetting('link_class_force'),
      ]);
    }
    if ($option == 'select_class') {
      $classes_available = $this
        ->getSelectOptions($this
        ->getSetting('link_class_select'), TRUE);
      $summary[] = $this
        ->t('Class(es) available: @link_class_select', [
        '@link_class_select' => $classes_available,
      ]);
    }
    return $summary;
  }

  /**
   * Return the options availables for the widget.
   *
   * @param string|null $key
   *   The optionnal key to retrieve.
   *
   * @return array|mixed
   *   The options array or the value corresponding to $key.
   */
  protected function getModeOptions($key = NULL) {
    $options = [
      'force_class' => $this
        ->t('Class are automatically added'),
      'select_class' => $this
        ->t('Let users select a class from a list'),
      'manual' => $this
        ->t('Users can set a class manually'),
    ];
    if ($key && isset($options[$key])) {
      return $options[$key];
    }
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $element = parent::formElement($items, $delta, $element, $form, $form_state);

    /** @var \Drupal\link\LinkItemInterface $item */
    $item = $items[$delta];
    $options = $item
      ->get('options')
      ->getValue();
    $mode = $this
      ->getSetting('link_class_mode');
    switch ($mode) {
      case 'manual':
        $element['options']['attributes']['class'] = [
          '#type' => 'textfield',
          '#title' => $this
            ->t('Link classes'),
          '#default_value' => !empty($options['attributes']['class']) ? $options['attributes']['class'] : '',
          '#description' => $this
            ->t('Add classes to the link. The classes must be separated by a space.'),
          '#size' => '30',
        ];
        break;
      case 'select_class':

        /** @var \Drupal\link\LinkItemInterface $item */
        $classes_available = $this
          ->getSelectOptions($this
          ->getSetting('link_class_select'));
        $default_value = !empty($options['attributes']['class']) ? $options['attributes']['class'] : '';
        $element['options']['attributes']['class'] = [
          '#type' => 'select',
          '#title' => $this
            ->t('Select a style'),
          '#options' => [
            '' => $this
              ->t('- None -'),
          ] + $classes_available,
          '#default_value' => $default_value,
        ];
        break;
      case 'force_class':
        $element['options']['attributes']['class'] = [
          '#type' => 'value',
          '#value' => $this
            ->getSetting('link_class_force'),
        ];
        break;
    }
    return $element;
  }

  /**
   * Convert textarea lines into an array.
   *
   * @param string $string
   *   The textarea lines to explode.
   * @param bool $summary
   *   A flag to return a formatted list of classes available.
   *
   * @return array
   *   An array keyed by the classes.
   */
  protected function getSelectOptions($string, $summary = FALSE) {
    $options = [];
    $lines = preg_split("/\\r\\n|\\r|\\n/", trim($string));
    $lines = array_filter($lines);
    foreach ($lines as $line) {
      list($class, $label) = explode('|', trim($line));
      $label = $label ?: $class;
      $options[$class] = $label;
    }
    if ($summary) {
      return implode(', ', array_keys($options));
    }
    return $options;
  }

}

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
LinkClassFieldWidget::defaultSettings public static function Defines the default settings for this plugin. Overrides LinkWidget::defaultSettings
LinkClassFieldWidget::formElement public function Returns the form for a single field widget. Overrides LinkWidget::formElement
LinkClassFieldWidget::getModeOptions protected function Return the options availables for the widget.
LinkClassFieldWidget::getSelectOptions protected function Convert textarea lines into an array.
LinkClassFieldWidget::selectClassDescription protected function Return the description for the class select mode.
LinkClassFieldWidget::settingsForm public function Returns a form to configure settings for the widget. Overrides LinkWidget::settingsForm
LinkClassFieldWidget::settingsSummary public function Returns a short summary for the current widget settings. Overrides LinkWidget::settingsSummary
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.
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