class ContentBlockPluginFieldWidget in Open Social 10.3.x
Same name and namespace in other branches
- 8.9 modules/social_features/social_content_block/src/Plugin/Field/FieldWidget/ContentBlockPluginFieldWidget.php \Drupal\social_content_block\Plugin\Field\FieldWidget\ContentBlockPluginFieldWidget
- 8.8 modules/social_features/social_content_block/src/Plugin/Field/FieldWidget/ContentBlockPluginFieldWidget.php \Drupal\social_content_block\Plugin\Field\FieldWidget\ContentBlockPluginFieldWidget
- 10.0.x modules/social_features/social_content_block/src/Plugin/Field/FieldWidget/ContentBlockPluginFieldWidget.php \Drupal\social_content_block\Plugin\Field\FieldWidget\ContentBlockPluginFieldWidget
- 10.1.x modules/social_features/social_content_block/src/Plugin/Field/FieldWidget/ContentBlockPluginFieldWidget.php \Drupal\social_content_block\Plugin\Field\FieldWidget\ContentBlockPluginFieldWidget
- 10.2.x modules/social_features/social_content_block/src/Plugin/Field/FieldWidget/ContentBlockPluginFieldWidget.php \Drupal\social_content_block\Plugin\Field\FieldWidget\ContentBlockPluginFieldWidget
Plugin implementation of the 'content_block_plugin_field' widget.
Plugin annotation
@FieldWidget(
id = "content_block_plugin_field",
label = @Translation("Content block plugin field"),
field_types = {
"string"
}
)
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
- class \Drupal\social_content_block\Plugin\Field\FieldWidget\ContentBlockPluginWidgetBase implements ContainerFactoryPluginInterface
- class \Drupal\social_content_block\Plugin\Field\FieldWidget\ContentBlockPluginFieldWidget
- class \Drupal\social_content_block\Plugin\Field\FieldWidget\ContentBlockPluginWidgetBase implements ContainerFactoryPluginInterface
- class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of ContentBlockPluginFieldWidget
File
- modules/
social_features/ social_content_block/ src/ Plugin/ Field/ FieldWidget/ ContentBlockPluginFieldWidget.php, line 22
Namespace
Drupal\social_content_block\Plugin\Field\FieldWidgetView source
class ContentBlockPluginFieldWidget extends ContentBlockPluginWidgetBase {
/**
* The prefix to search for.
*/
const CONFIG_PREFIX = 'field.field.block_content.custom_content_list.';
/**
* An array containing matching configuration object names.
*
* @var array
*/
protected $fieldConfigs;
/**
* Constructs a ContentBlockPluginFieldWidget object.
*
* @param string $plugin_id
* The plugin_id for the widget.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The definition of the field to which the widget is associated.
* @param array $settings
* The widget settings.
* @param array $third_party_settings
* Any third party settings.
* @param \Drupal\social_content_block\ContentBlockManagerInterface $content_block_manager
* The content block manager.
* @param array $field_configs
* An array containing matching configuration object names.
*/
public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, ContentBlockManagerInterface $content_block_manager, array $field_configs) {
parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings, $content_block_manager);
$this->fieldConfigs = $field_configs;
}
/**
* {@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.content_block'), $container
->get('config.factory')
->listAll(self::CONFIG_PREFIX));
}
/**
* {@inheritdoc}
*/
public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
$element = parent::formElement($items, $delta, $element, $form, $form_state);
$selected_plugin_id = $items
->getEntity()->field_plugin_id->value;
$selector = $this->contentBlockManager
->getSelector('field_plugin_id', 'value', $element['#field_parents']);
foreach ($this->contentBlockManager
->getDefinitions() as $plugin_id => $plugin_definition) {
$element[$plugin_id] = [
'#type' => 'select',
'#title' => $element['value']['#title'],
'#description' => $element['value']['#description'],
'#empty_value' => 'all',
'#empty_option' => t('All'),
'#weight' => -1,
'#states' => [
'visible' => [
$selector => [
'value' => $plugin_id,
],
],
],
];
if ($selected_plugin_id === $plugin_id) {
$element[$plugin_id]['#default_value'] = $element['value']['#default_value'];
}
if (!empty($plugin_definition['fields'])) {
foreach ($plugin_definition['fields'] as $field) {
if (isset($form[$field])) {
// Depending on the field type the field title to filter by is in
// different places.
// For entity reference fields.
if (isset($form[$field]['widget']['target_id']['#title'])) {
$element[$plugin_id]['#options'][$field] = $form[$field]['widget']['target_id']['#title'];
}
elseif (isset($form[$field]['widget']['#title'])) {
$element[$plugin_id]['#options'][$field] = $form[$field]['widget']['#title'];
}
else {
$element[$plugin_id]['#options'][$field] = "-- Could not find widget title for '{$field}' in " . self::class . ' --';
}
$form[$field]['#states'] = [
'visible' => [
$selector => [
'value' => $plugin_id,
],
$this->contentBlockManager
->getSelector('field_plugin_field', $plugin_id) => [
[
'value' => 'all',
],
[
'value' => $field,
],
],
],
];
}
elseif (in_array(self::CONFIG_PREFIX . $field, $this->fieldConfigs)) {
// Add the field machine name instead of the field label when the
// field still not added to the form structure. The field will be
// processed in the following place:
// @see \Drupal\social_content_block\ContentBuilder::processBlockForm()
$element[$plugin_id]['#options'][$field] = $field;
}
}
}
else {
$element[$plugin_id]['#options'] = [];
}
}
$element['#element_validate'][] = [
get_class($this),
'validateElement',
];
return $element;
}
/**
* Form validation handler for widget elements.
*
* @param array $element
* The form element.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The form state.
*/
public static function validateElement(array $element, FormStateInterface $form_state) {
$value = $form_state
->getValue([
'field_plugin_field',
0,
$form_state
->getValue([
'field_plugin_id',
0,
'value',
]),
]);
if ($value === 'all') {
$form_state
->setValueForElement($element, NULL);
}
else {
$form_state
->setValueForElement($element, [
'value' => $value,
]);
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ContentBlockPluginFieldWidget:: |
protected | property | An array containing matching configuration object names. | |
ContentBlockPluginFieldWidget:: |
constant | The prefix to search for. | ||
ContentBlockPluginFieldWidget:: |
public static | function |
Creates an instance of the plugin. Overrides ContentBlockPluginWidgetBase:: |
|
ContentBlockPluginFieldWidget:: |
public | function |
Returns the form for a single field widget. Overrides ContentBlockPluginWidgetBase:: |
|
ContentBlockPluginFieldWidget:: |
public static | function | Form validation handler for widget elements. | |
ContentBlockPluginFieldWidget:: |
public | function |
Constructs a ContentBlockPluginFieldWidget object. Overrides ContentBlockPluginWidgetBase:: |
|
ContentBlockPluginWidgetBase:: |
protected | property | The content block manager. | |
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
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:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginSettingsBase:: |
protected | property | Whether default settings have been merged into the current $settings. | |
PluginSettingsBase:: |
protected | property | The plugin settings injected by third party modules. | |
PluginSettingsBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
6 |
PluginSettingsBase:: |
public static | function |
Defines the default settings for this plugin. Overrides PluginSettingsInterface:: |
42 |
PluginSettingsBase:: |
public | function |
Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
protected | function | Merges default settings values into $settings. | |
PluginSettingsBase:: |
public | function |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface:: |
3 |
PluginSettingsBase:: |
public | function |
Sets the value of a setting for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the settings for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
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. | |
WidgetBase:: |
protected | property | The field definition. | |
WidgetBase:: |
protected | property |
The widget settings. Overrides PluginSettingsBase:: |
|
WidgetBase:: |
public static | function | Ajax callback for the "Add another item" button. | |
WidgetBase:: |
public static | function | Submission handler for the "Add another item" button. | |
WidgetBase:: |
public static | function | After-build handler for field elements in a form. | |
WidgetBase:: |
public | function |
Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface:: |
8 |
WidgetBase:: |
public | function |
Extracts field values from submitted form values. Overrides WidgetBaseInterface:: |
2 |
WidgetBase:: |
public | function |
Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface:: |
2 |
WidgetBase:: |
public | function |
Creates a form element for a field. Overrides WidgetBaseInterface:: |
3 |
WidgetBase:: |
protected | function | Special handling to create form elements for multiple values. | 1 |
WidgetBase:: |
protected | function | Generates the form element for a single copy of the widget. | |
WidgetBase:: |
protected | function | Returns the value of a field setting. | |
WidgetBase:: |
protected | function | Returns the array of field settings. | |
WidgetBase:: |
protected | function | Returns the filtered field description. | |
WidgetBase:: |
public static | function |
Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface:: |
|
WidgetBase:: |
protected static | function | Returns the location of processing information within $form_state. | |
WidgetBase:: |
protected | function | Returns whether the widget handles multiple values. | |
WidgetBase:: |
public static | function |
Returns if the widget can be used for the provided field. Overrides WidgetInterface:: |
4 |
WidgetBase:: |
protected | function | Returns whether the widget used for default value form. | |
WidgetBase:: |
public | function |
Massages the form values into the format expected for field values. Overrides WidgetInterface:: |
7 |
WidgetBase:: |
public | function |
Returns a form to configure settings for the widget. Overrides WidgetInterface:: |
16 |
WidgetBase:: |
public | function |
Returns a short summary for the current widget settings. Overrides WidgetInterface:: |
15 |
WidgetBase:: |
public static | function |
Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface:: |