class SocialLinkWidget in Social Link Field 8

Plugin implementation of the 'open_hours' widget.

Plugin annotation


@FieldWidget(
  id = "social_links",
  label = @Translation("Social links"),
  field_types = {
    "social_links"
  }
)

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\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
    class \Drupal\social_link_field\Plugin\Field\FieldWidget\SocialLinkWidget implements ContainerFactoryPluginInterface

Expanded class hierarchy of SocialLinkWidget

File

src/Plugin/Field/FieldWidget/SocialLinkWidget.php, line 29

Namespace

Drupal\social_link_field\Plugin\Field\FieldWidget

View source

class SocialLinkWidget extends WidgetBase implements ContainerFactoryPluginInterface {

  /**
   * Platform of social networks.
   *
   * @var array
   */
  protected $platforms;

  /**
   * Route name.
   *
   * @var string
   */
  protected $routeName;

  /**
   * Field cardinality.
   *
   * @var int
   */
  protected $cardinality;

  /**
   * {@inheritdoc}
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, $platforms_service, $route_match) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
    $this->platforms = $platforms_service
      ->getPlatforms();

    // Limit available platforms to the field settings.
    if ($limited_platforms = $field_definition
      ->getSetting('platforms')) {
      if ($limited_platforms = array_filter($limited_platforms)) {
        $this->platforms = array_intersect_key($this->platforms, $limited_platforms);
      }
    }
    $this->routeName = $route_match
      ->getRouteName();
    $this->cardinality = $this->fieldDefinition
      ->getFieldStorageDefinition()
      ->getCardinality();
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['third_party_settings'], $container
      ->get('plugin.manager.social_link_field.platform'), $container
      ->get('current_route_match'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'select_social' => FALSE,
      'disable_weight' => FALSE,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = [];
    if ($this->cardinality > 0) {
      $element['select_social'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Possibility to select social network'),
        '#default_value' => $this
          ->getSetting('select_social'),
      ];
    }
    $element['disable_weight'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Forbidden to change weight'),
      '#default_value' => $this
        ->getSetting('disable_weight'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $field_name = $this->fieldDefinition
      ->getName();
    $parents = array_merge($element['#field_parents'], [
      $field_name,
      $delta,
    ]);
    $element['#parents'] = $parents;
    $field_required = $this->fieldDefinition
      ->isRequired();
    $admin_route = !(stripos($this->routeName, 'entity.field_config') === FALSE);
    $unlimited = $this->cardinality == FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED;

    // Detect if we need to show or hide social select.
    // We show social select if this setting is checked,
    // cardinality is unlimited, or we are on field config form.
    $enable_social = $this
      ->getSetting('select_social') || $unlimited || $admin_route ? TRUE : FALSE;

    // Detect default values.
    $default_vales = $this
      ->getFormValues($enable_social, $items, $delta, $form_state);
    $social = $default_vales['social'];
    $link = $default_vales['link'];

    // Social network select.
    $element['social'] = [
      '#type' => $enable_social ? 'select' : 'hidden',
      '#title' => $this
        ->t('Social network'),
      '#default_value' => $social,
      '#empty_option' => $this
        ->t('- Select -'),
      '#empty_value' => '',
      '#data' => [
        'field_name' => $field_name,
        'delta' => $delta,
      ],
      '#ajax' => [
        'event' => 'change',
        'callback' => [
          $this,
          'updateLinkName',
        ],
      ],
    ];
    foreach ($this->platforms as $platform) {
      $element['social']['#options'][$platform['id']] = $platform['name']
        ->getUntranslatedString();
    }

    // Social link input.
    // Required when not in config, enable social is active & social newtwork
    // is set.
    $link_required = $field_required || $unlimited && !empty($social) && !$admin_route;
    $element['link'] = [
      '#type' => 'textfield',
      '#title' => $enable_social || empty($social) ? $this
        ->t('Profile link') : $this->platforms[$social]['name']
        ->getUntranslatedString(),
      '#required' => $link_required,
      '#default_value' => $link,
      '#attributes' => [],
      '#field_prefix' => !empty($social) ? $this->platforms[$social]['urlPrefix'] : '',
      '#prefix' => '<div id="' . $field_name . '-' . $delta . '-link-wrapper">',
      '#suffix' => '</div>',
    ];

    // Remove item button.
    if ($this->cardinality == FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED) {
      $element['actions'] = [
        '#type' => 'actions',
        'remove_button' => [
          '#delta' => $delta,
          '#name' => implode('_', $parents) . '_remove_button',
          '#type' => 'submit',
          '#value' => $this
            ->t('Remove'),
          '#limit_validation_errors' => [],
          '#submit' => [
            [
              static::class,
              'removeSubmit',
            ],
          ],
          '#ajax' => [
            'callback' => [
              $this,
              'ajaxRemove',
            ],
            'effect' => 'fade',
            'wrapper' => $form['#wrapper_id'],
          ],
          '#weight' => 1000,
        ],
      ];
    }
    return $element;
  }

  /**
   * Ajax callback function for update link dynamically.
   *
   * @param array $form
   *   Form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form state.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   Request.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   Ajax response.
   */
  public function updateLinkName(array $form, FormStateInterface $form_state, Request $request) {
    $response = new AjaxResponse();
    $element = $form_state
      ->getTriggeringElement();
    $field_name = $element['#data']['field_name'];
    $delta = $element['#data']['delta'];

    // Get field element on default field settings form.
    if (isset($form['default_value']) && $form['default_value']['widget']['#field_name'] == $field_name) {
      $element_link = $form['default_value']['widget'][$delta]['link'];
    }
    else {
      $element_link = $form[$field_name]['widget'][$delta]['link'];
    }
    if (!empty($element['#value'])) {
      $element_link['#field_prefix'] = $this->platforms[$element['#value']]['urlPrefix'];
    }
    $response
      ->addCommand(new ReplaceCommand('#' . $field_name . '-' . $delta . '-link-wrapper', $element_link));
    return $response;
  }

  /**
   * Ensure items order to prevent delta issues.
   *
   * @param \Drupal\Core\Field\FieldItemListInterface $items
   *   Original items.
   */
  protected function ensureItemsOrder(FieldItemListInterface $items) {
    $default_values = $this->fieldDefinition
      ->getDefaultValueLiteral();
    $items_array = $items
      ->getValue();
    $new_items = [];
    $map = [];

    // Try to locate delta from default value.
    // Working even with multiple same rrss.
    foreach ($default_values as $default_delta => $default) {
      $set = FALSE;
      foreach ($items_array as $saved_delta => $item) {

        // Already located.
        if ($item['social'] == $default['social'] && !in_array($saved_delta, $map)) {
          $new_items[$default_delta] = $items_array[$saved_delta];
          $map[$default_delta] = $saved_delta;
          $set = TRUE;
          continue 2;
        }
      }
      if (!$set) {
        $new_items[$default_delta] = $default;
      }
    }
    $items
      ->setValue($new_items);
  }

  /**
   * {@inheritdoc}
   */
  protected function formMultipleElements(FieldItemListInterface $items, array &$form, FormStateInterface $form_state) {
    $form['#wrapper_id'] = Html::getUniqueID($items
      ->getName());

    // Just in this case is important to preserve default value order.
    if (!$this
      ->getSetting('select_social') && $this->cardinality !== FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED && stripos($this->routeName, 'entity.field_config') === FALSE) {
      $this
        ->ensureItemsOrder($items);
    }
    $elements = parent::formMultipleElements($items, $form, $form_state);
    $elements['#prefix'] = '<div id="' . $form['#wrapper_id'] . '">';
    $elements['#suffix'] = '</div>';
    $elements['add_more']['#ajax']['wrapper'] = $form['#wrapper_id'];
    if ($this
      ->getSetting('disable_weight')) {

      // Disable item order change.
      $elements['#theme'] = 'field_multiple_value_no_draggable_form';
    }
    return $elements;
  }

  /**
   * Submit callback to remove an item from the field UI multiple wrapper.
   *
   * @param array $form
   *   The form structure where widgets are being attached to.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public static function removeSubmit(array $form, FormStateInterface $form_state) {
    $button = $form_state
      ->getTriggeringElement();
    $delta = $button['#delta'];
    $address = array_slice($button['#array_parents'], 0, -4);
    $address_state = array_slice($button['#parents'], 0, -3);
    $parent_element = NestedArray::getValue($form, array_merge($address, [
      'widget',
    ]));
    $field_name = $parent_element['#field_name'];
    $parents = $parent_element['#field_parents'];
    $field_state = static::getWidgetState($parents, $field_name, $form_state);
    for ($i = $delta; $i <= $field_state['items_count']; $i++) {
      $old_element_address = array_merge($address, [
        'widget',
        $i + 1,
      ]);
      $old_element_state_address = array_merge($address_state, [
        $i + 1,
      ]);
      $new_element_state_address = array_merge($address_state, [
        $i,
      ]);
      $moving_element = NestedArray::getValue($form, $old_element_address);
      $moving_element_value = NestedArray::getValue($form_state
        ->getValues(), $old_element_state_address);
      $moving_element_input = NestedArray::getValue($form_state
        ->getUserInput(), $old_element_state_address);
      $moving_element_field = NestedArray::getValue($form_state
        ->get('field_storage'), array_merge([
        '#parents',
      ], $address));
      $moving_element['#parents'] = $new_element_state_address;
      $form_state
        ->setValueForElement($moving_element, $moving_element_value);
      $user_input = $form_state
        ->getUserInput();
      NestedArray::setValue($user_input, $moving_element['#parents'], $moving_element_input);
      $form_state
        ->setUserInput($user_input);
      NestedArray::setValue($form_state
        ->get('field_storage'), array_merge([
        '#parents',
      ], $moving_element['#parents']), $moving_element_field);
    }
    if ($field_state['items_count'] > 0) {
      $field_state['items_count']--;
    }
    static::setWidgetState($parents, $field_name, $form_state, $field_state);
    $form_state
      ->setRebuild();
  }

  /**
   * Ajax callback to remove a field collection from a multi-valued field.
   *
   * @param array $form
   *   The form structure where widgets are being attached to.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   An AjaxResponse object.
   */
  public function ajaxRemove(array $form, FormStateInterface &$form_state) {
    $button = $form_state
      ->getTriggeringElement();
    $parent = NestedArray::getValue($form, array_slice($button['#array_parents'], 0, -3));
    return $parent;
  }

  /**
   * Provide default form values.
   *
   * @param bool $enable_social
   *   Necessity to show or hide social select.
   * @param \Drupal\Core\Field\FieldItemListInterface $items
   *   Array of default values for this field.
   * @param int $delta
   *   The order of this item in the array of sub-elements.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return string[]
   *   Returns default item values.
   */
  protected function getFormValues($enable_social, FieldItemListInterface $items, $delta, FormStateInterface $form_state) {
    $entity_values = $items[$delta];
    $default_values = $this->fieldDefinition
      ->getDefaultValueLiteral();
    $is_ajax_callback = $form_state
      ->isRebuilding();
    $apply_items_value = !$is_ajax_callback && $entity_values->social;
    $apply_default_value = !$is_ajax_callback && $items
      ->isEmpty() && !empty($default_values) && isset($default_values[$delta]);

    // Values must be obtained from form state when is rebuilding.
    $form_state_raw = $form_state
      ->getValue($this->fieldDefinition
      ->getName());
    $form_state_default = !empty($form_state_raw) && !empty($form_state_raw[$delta]) ? $form_state_raw[$delta] : NULL;
    $apply_state_value = $is_ajax_callback && !empty($form_state_default);

    // From form config.
    if ($apply_default_value) {
      $social = $default_values[$delta]['social'];
      $link = $default_values[$delta]['link'];
    }
    else {
      if ($apply_items_value) {
        $social = $entity_values->social;
        $link = $entity_values->link;
      }
      else {
        if ($apply_state_value) {
          $social = $form_state_default['social'];
          $link = $form_state_default['link'];
        }
        else {
          $social = '';
          $link = '';
        }
      }
    }
    return [
      'social' => $social,
      'link' => $link,
    ];
  }

}

Members

Name	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
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
SocialLinkWidget::$cardinality	protected	property	Field cardinality.
SocialLinkWidget::$platforms	protected	property	Platform of social networks.
SocialLinkWidget::$routeName	protected	property	Route name.
SocialLinkWidget::ajaxRemove	public	function	Ajax callback to remove a field collection from a multi-valued field.
SocialLinkWidget::create	public static	function	Creates an instance of the plugin. Overrides WidgetBase::create
SocialLinkWidget::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
SocialLinkWidget::ensureItemsOrder	protected	function	Ensure items order to prevent delta issues.
SocialLinkWidget::formElement	public	function	Returns the form for a single field widget. Overrides WidgetInterface::formElement
SocialLinkWidget::formMultipleElements	protected	function	Special handling to create form elements for multiple values. Overrides WidgetBase::formMultipleElements
SocialLinkWidget::getFormValues	protected	function	Provide default form values.
SocialLinkWidget::removeSubmit	public static	function	Submit callback to remove an item from the field UI multiple wrapper.
SocialLinkWidget::settingsForm	public	function	Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
SocialLinkWidget::updateLinkName	public	function	Ajax callback function for update link dynamically.
SocialLinkWidget::__construct	public	function	Constructs a WidgetBase object. Overrides WidgetBase::__construct
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::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::flagErrors	public	function	Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors	2
WidgetBase::form	public	function	Creates a form element for a field. Overrides WidgetBaseInterface::form	3
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::massageFormValues	public	function	Massages the form values into the format expected for field values. Overrides WidgetInterface::massageFormValues	7
WidgetBase::settingsSummary	public	function	Returns a short summary for the current widget settings. Overrides WidgetInterface::settingsSummary	15
WidgetBase::setWidgetState	public static	function	Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState

You are here

class SocialLinkWidget in Social Link Field 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation