class ParagraphsBrowserPreviewerWidget in Paragraphs Browser+Previewer 8
Plugin implementation of the 'entity_reference paragraphs' widget.
We hide add / remove buttons when translating to avoid accidental loss of data because these actions effect all languages.
Plugin annotation
@FieldWidget(
id = "paragraphs_browser_previewer",
label = @Translation("Paragraphs Browser Previewer EXPERIMENTAL"),
description = @Translation("An paragraphs inline form widget with a Browser Previewer."),
field_types = {
"entity_reference_revisions"
}
)
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\paragraphs\Plugin\Field\FieldWidget\ParagraphsWidget
- class \Drupal\paragraphs_browser_previewer\Plugin\Field\FieldWidget\ParagraphsBrowserPreviewerWidget uses ParagraphsPreviewerWidgetTrait
- class \Drupal\paragraphs\Plugin\Field\FieldWidget\ParagraphsWidget
- class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of ParagraphsBrowserPreviewerWidget
File
- src/
Plugin/ Field/ FieldWidget/ ParagraphsBrowserPreviewerWidget.php, line 24
Namespace
Drupal\paragraphs_browser_previewer\Plugin\Field\FieldWidgetView source
class ParagraphsBrowserPreviewerWidget extends ParagraphsWidget {
use ParagraphsPreviewerWidgetTrait, ParagraphsBrowserWidgetTrait {
ParagraphsBrowserWidgetTrait::defaultSettings insteadof ParagraphsPreviewerWidgetTrait;
ParagraphsBrowserWidgetTrait::formMultipleElements insteadof ParagraphsPreviewerWidgetTrait;
ParagraphsPreviewerWidgetTrait::formElement insteadof ParagraphsBrowserWidgetTrait;
}
/**
* Returns select options for a plugin setting.
*
* This is done to allow
* \Drupal\paragraphs\Plugin\Field\FieldWidget\ParagraphsWidget::settingsSummary()
* to access option labels. Not all plugin setting are available.
*
* @param string $setting_name
* The name of the widget setting. Supported settings:
* - "edit_mode"
* - "closed_mode"
* - "autocollapse"
* - "add_mode",
*
* @return array|null
* An array of setting option usable as a value for a "#options" key.
*
* @see \Drupal\paragraphs\Plugin\Field\FieldWidget\ParagraphsWidget::settingsSummary()
*/
protected function getSettingOptions($setting_name) {
$options = parent::getSettingOptions($setting_name);
switch ($setting_name) {
case 'add_mode':
$options['paragraphs_browser'] = $this
->t('Paragraphs Browser');
break;
}
return $options;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AllowedTagsXssTrait:: |
public | function | Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss(). | |
AllowedTagsXssTrait:: |
public | function | Returns a human-readable list of allowed tags for display in help texts. | |
AllowedTagsXssTrait:: |
public | function | Filters an HTML string to prevent XSS vulnerabilities. | |
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 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
ParagraphsBrowserPreviewerWidget:: |
protected | function |
Returns select options for a plugin setting. Overrides ParagraphsWidget:: |
|
ParagraphsPreviewerWidgetTrait:: |
public static | function | Previewer button AJAX callback. | |
ParagraphsPreviewerWidgetTrait:: |
public static | function | ||
ParagraphsPreviewerWidgetTrait:: |
public | function | Uses a similar approach to populate a new translation. | |
ParagraphsPreviewerWidgetTrait:: |
public | function | Determine if the previewer is enabled for the given paragraphs edit mode. | |
ParagraphsPreviewerWidgetTrait:: |
public | function | ||
ParagraphsPreviewerWidgetTrait:: |
public static | function | Previewer button submit callback. | |
ParagraphsWidget:: |
protected | property | Accessible paragraphs types. | |
ParagraphsWidget:: |
protected | property | Id to name ajax buttons that includes field parents and field name. | |
ParagraphsWidget:: |
protected | property | Parents for the current paragraph. | |
ParagraphsWidget:: |
protected | property | Wrapper id to identify the paragraphs. | |
ParagraphsWidget:: |
protected | property | Indicates whether the current widget instance is in translation. | |
ParagraphsWidget:: |
protected | property | Number of paragraphs item on form. | |
ParagraphsWidget:: |
constant | Action position is in the actions section of the widget. | ||
ParagraphsWidget:: |
constant | Action position is in the add paragraphs place. | ||
ParagraphsWidget:: |
constant | Action position is in the table header section. | ||
ParagraphsWidget:: |
public static | function |
Ajax callback for the "Add another item" button. Overrides WidgetBase:: |
|
ParagraphsWidget:: |
public static | function |
Submission handler for the "Add another item" button. Overrides WidgetBase:: |
|
ParagraphsWidget:: |
public static | function | After-build callback for adding the translatability clue from the widget. | |
ParagraphsWidget:: |
public static | function | Ajax callback for all actions. | |
ParagraphsWidget:: |
protected | function | Checks if we can allow reference changes. | |
ParagraphsWidget:: |
public static | function | Returns a state with all paragraphs closed, if autocollapse is enabled. | |
ParagraphsWidget:: |
protected | function | Add 'add more' button, if not working with a programmed form. | |
ParagraphsWidget:: |
protected | function | Builds dropdown button for adding new paragraph. | |
ParagraphsWidget:: |
protected | function | Build drop button. | |
ParagraphsWidget:: |
public | function | Builds header actions. | |
ParagraphsWidget:: |
protected | function | Builds an add paragraph button for opening of modal form. | |
ParagraphsWidget:: |
protected | function | Builds the nested drag and drop structure. | |
ParagraphsWidget:: |
protected | function | Builds list of actions based on paragraphs type. | |
ParagraphsWidget:: |
public static | function | Loops through all paragraphs and change mode for each paragraph instance. | |
ParagraphsWidget:: |
public | function | Helper to create a paragraph UI message. | |
ParagraphsWidget:: |
public static | function | Ajax callback for the dragdrop mode. | |
ParagraphsWidget:: |
public static | function | Sets the form mode accordingly. | |
ParagraphsWidget:: |
protected | function | Check duplicate button access. | |
ParagraphsWidget:: |
public static | function | Creates a duplicate of the paragraph entity. | |
ParagraphsWidget:: |
public | function | ||
ParagraphsWidget:: |
public | function |
Assigns a field-level validation error to the right widget sub-element. Overrides WidgetBase:: |
|
ParagraphsWidget:: |
public static | function | Expand button base array into a paragraph widget action button. | |
ParagraphsWidget:: |
public | function |
Extracts field values from submitted form values. Overrides WidgetBase:: |
|
ParagraphsWidget:: |
public | function |
Reports field-level validation errors against actual form elements. Overrides WidgetBase:: |
|
ParagraphsWidget:: |
public | function |
Creates a form element for a field. Overrides WidgetBase:: |
|
ParagraphsWidget:: |
public | function |
Special handling to create form elements for multiple values. Overrides WidgetBase:: |
|
ParagraphsWidget:: |
protected | function | Returns the available paragraphs type. | |
ParagraphsWidget:: |
public | function | Returns the sorted allowed types for a entity reference field. | |
ParagraphsWidget:: |
protected | function | Returns a list of child paragraphs for a given field to loop over. | |
ParagraphsWidget:: |
protected | function | Returns the default paragraph type. | |
ParagraphsWidget:: |
protected | function | Returns the machine name for default paragraph type. | |
ParagraphsWidget:: |
protected | function | Counts the number of paragraphs in a certain mode in a form substructure. | |
ParagraphsWidget:: |
protected | function | Returns the value of a setting for the entity reference selection handler. | |
ParagraphsWidget:: |
public static | function | Get common submit element information for processing ajax submit handlers. | |
ParagraphsWidget:: |
protected | function | Determine if widget is in translation. | |
ParagraphsWidget:: |
public static | function |
Returns if the widget can be used for the provided field. Overrides WidgetBase:: |
|
ParagraphsWidget:: |
protected | function | Checks if a widget feature is enabled or not. | |
ParagraphsWidget:: |
public static | function | ||
ParagraphsWidget:: |
public | function |
Massages the form values into the format expected for field values. Overrides WidgetBase:: |
|
ParagraphsWidget:: |
public | function | Special handling to validate form elements with multiple values. | |
ParagraphsWidget:: |
public static | function | ||
ParagraphsWidget:: |
protected static | function | Prepares the widget state to add a new paragraph at a specific position. | |
ParagraphsWidget:: |
protected | function | Check remove button access. | |
ParagraphsWidget:: |
protected static | function | Reorder paragraphs. | |
ParagraphsWidget:: |
public | function |
Returns a form to configure settings for the widget. Overrides WidgetBase:: |
|
ParagraphsWidget:: |
public | function |
Constructs a ParagraphsWidget object. Overrides WidgetBase:: |
|
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. | |
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 | 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. | 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. | |
WidgetBase:: |
protected | property | The field definition. | |
WidgetBase:: |
protected | property |
The widget settings. Overrides PluginSettingsBase:: |
|
WidgetBase:: |
public static | function | After-build handler for field elements in a form. | |
WidgetBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
5 |
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:: |
protected | function | Returns whether the widget used for default value form. | |
WidgetBase:: |
public static | function |
Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface:: |