class SocialMediaLinksPlatforms in Social Media Links Block and Field 8.2
Provides an social media links form element.
Plugin annotation
@FormElement("social_media_links_platforms");
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\social_media_links_field\Element\SocialMediaLinksPlatforms
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of SocialMediaLinksPlatforms
1 #type use of SocialMediaLinksPlatforms
- SocialMediaLinksFieldSelectWidget::formElement in modules/
social_media_links_field/ src/ Plugin/ Field/ FieldWidget/ SocialMediaLinksFieldSelectWidget.php - Returns the form for a single field widget.
File
- modules/
social_media_links_field/ src/ Element/ SocialMediaLinksPlatforms.php, line 15
Namespace
Drupal\social_media_links_field\ElementView source
class SocialMediaLinksPlatforms extends FormElement {
/**
* {@inheritdoc}
*/
public function getInfo() {
$class = get_class($this);
return [
'#available_platforms' => [],
'#multiple' => FALSE,
'#default_value' => NULL,
'#process' => [
[
$class,
'processElement',
],
],
'#theme_wrappers' => [
'container',
],
];
}
/**
* Process the platform form element.
*
* @param array $element
* The form element to process.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
* @param array $complete_form
* The complete form structure.
*
* @return array
* The processed element.
*/
public static function processElement(array &$element, FormStateInterface $form_state, array &$complete_form) {
$id_prefix = implode('-', $element['#parents']);
$wrapper_id = Html::getUniqueId($id_prefix . '-ajax-wrapper');
$value = $element['#value'];
// If only one available platform selectable, remove the platform
// selection and display the value form for the platform directly.
if (count($element['#available_platforms']) < 2) {
$value['platform'] = array_keys($element['#available_platforms'])[0];
$element = static::platformElements($element, $value);
$element['value']['#title_display'] = 'before';
return $element;
}
$element = [
'#tree' => TRUE,
'#prefix' => '<div id="' . $wrapper_id . '">',
'#suffix' => '</div>',
'#wrapper_id' => $wrapper_id,
] + $element;
$element['platform'] = [
'#type' => 'select',
'#title' => t('Platform'),
'#options' => $element['#available_platforms'],
'#default_value' => $value['platform'],
'#empty_value' => '',
'#ajax' => [
'callback' => [
get_called_class(),
'ajaxRefresh',
],
'wrapper' => $wrapper_id,
],
'#weight' => -100,
];
if (!empty($value['platform'])) {
$element = static::platformElements($element, $value);
}
return $element;
}
/**
* Builds the specific platform elements.
*
* @param array $element
* The existing form elment array.
* @param array $value
* The platform values.
*
* @return array
* The modified form element array containing the platform specific
* elements.
*/
protected static function platformElements(array $element, array $value) {
$platforms = \Drupal::service('plugin.manager.social_media_links.platform')
->getPlatforms();
$selected_platform = $platforms[$value['platform']];
$element['value'] = [
'#type' => 'textfield',
'#title' => $selected_platform['name']
->render(),
'#title_display' => 'invisible',
'#size' => 40,
'#default_value' => isset($value['value']) ? $value['value'] : '',
'#field_prefix' => $selected_platform['instance']
->getUrlPrefix(),
'#field_suffix' => $selected_platform['instance']
->getUrlSuffix(),
'#element_validate' => [
[
get_class($selected_platform['instance']),
'validateValue',
],
],
];
if (!empty($selected_platform['instance']
->getFieldDescription())) {
$element['value']['#description'] = $selected_platform['instance']
->getFieldDescription();
}
return $element;
}
/**
* Ajax callback.
*
* @param array $form
* The form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
*
* @return array
* $platform_field_element
*/
public static function ajaxRefresh(array $form, FormStateInterface $form_state) {
$platform_element = $form_state
->getTriggeringElement();
$platform_field_element = NestedArray::getValue($form, array_slice($platform_element['#array_parents'], 0, -2));
unset($platform_field_element['_weight']);
return $platform_field_element;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormElement:: |
public static | function | Adds autocomplete functionality to elements. | |
FormElement:: |
public static | function | #process callback for #pattern form element property. | |
FormElement:: |
public static | function | #element_validate callback for #pattern form element property. | |
FormElement:: |
public static | function |
Determines how user input is mapped to an element's #value property. Overrides FormElementInterface:: |
15 |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 92 |
RenderElement:: |
public static | function | Adds Ajax information about an element to communicate with JavaScript. | |
RenderElement:: |
public static | function | Adds members of this group as actual elements for rendering. | |
RenderElement:: |
public static | function | Form element processing handler for the #ajax form property. | 1 |
RenderElement:: |
public static | function | Arranges elements into groups. | |
RenderElement:: |
public static | function |
Sets a form element's class attribute. Overrides ElementInterface:: |
|
SocialMediaLinksPlatforms:: |
public static | function | Ajax callback. | |
SocialMediaLinksPlatforms:: |
public | function |
Returns the element properties for this element. Overrides ElementInterface:: |
|
SocialMediaLinksPlatforms:: |
protected static | function | Builds the specific platform elements. | |
SocialMediaLinksPlatforms:: |
public static | function | Process the platform form element. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |