class ParagraphsBrowserWidget in Paragraphs Browser 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",
  label = @Translation("Paragraphs Browser EXPERIMENTAL"),
  description = @Translation("An experimental paragraphs inline form widget with a 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\Plugin\Field\FieldWidget\ParagraphsBrowserWidget uses ParagraphsBrowserWidgetTrait

Expanded class hierarchy of ParagraphsBrowserWidget

File

src/Plugin/Field/FieldWidget/ParagraphsBrowserWidget.php, line 29: Paragraphs Previewer widget implementation for paragraphs.

Namespace

Drupal\paragraphs_browser\Plugin\Field\FieldWidget

View source

class ParagraphsBrowserWidget extends ParagraphsWidget {
  use ParagraphsBrowserWidgetTrait;

  /**
   * {@inheritdoc}
   */
  public function form(FieldItemListInterface $items, array &$form, FormStateInterface $form_state, $get_delta = NULL) {
    $elements = parent::form($items, $form, $form_state, $get_delta);
    if ($elements) {

      // Add the widget class of the parent widget so that our widget is
      // styled the same.
      $elements['#attributes']['class'][] = 'field--widget-paragraphs';
    }
    return $elements;
  }

  /**
   * 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::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.
ParagraphsBrowserWidget::form	public	function	Creates a form element for a field. Overrides ParagraphsWidget::form
ParagraphsBrowserWidget::getSettingOptions	protected	function	Returns select options for a plugin setting. Overrides ParagraphsWidget::getSettingOptions
ParagraphsBrowserWidgetTrait::defaultSettings	public static	function
ParagraphsBrowserWidgetTrait::formMultipleElements	public	function
ParagraphsBrowserWidgetTrait::settingsForm	public	function
ParagraphsWidget::$accessOptions	protected	property	Accessible paragraphs types.
ParagraphsWidget::$fieldIdPrefix	protected	property	Id to name ajax buttons that includes field parents and field name.
ParagraphsWidget::$fieldParents	protected	property	Parents for the current paragraph.
ParagraphsWidget::$fieldWrapperId	protected	property	Wrapper id to identify the paragraphs.
ParagraphsWidget::$isTranslating	protected	property	Indicates whether the current widget instance is in translation.
ParagraphsWidget::$realItemCount	protected	property	Number of paragraphs item on form.
ParagraphsWidget::ACTION_POSITION_ACTIONS		constant	Action position is in the actions section of the widget.
ParagraphsWidget::ACTION_POSITION_BASE		constant	Action position is in the add paragraphs place.
ParagraphsWidget::ACTION_POSITION_HEADER		constant	Action position is in the table header section.
ParagraphsWidget::addMoreAjax	public static	function	Ajax callback for the "Add another item" button. Overrides WidgetBase::addMoreAjax
ParagraphsWidget::addMoreSubmit	public static	function	Submission handler for the "Add another item" button. Overrides WidgetBase::addMoreSubmit
ParagraphsWidget::addTranslatabilityClue	public static	function	After-build callback for adding the translatability clue from the widget.
ParagraphsWidget::allActionsAjax	public static	function	Ajax callback for all actions.
ParagraphsWidget::allowReferenceChanges	protected	function	Checks if we can allow reference changes.
ParagraphsWidget::autocollapse	public static	function	Returns a state with all paragraphs closed, if autocollapse is enabled.
ParagraphsWidget::buildAddActions	protected	function	Add 'add more' button, if not working with a programmed form.
ParagraphsWidget::buildButtonsAddMode	protected	function	Builds dropdown button for adding new paragraph.
ParagraphsWidget::buildDropbutton	protected	function	Build drop button.
ParagraphsWidget::buildHeaderActions	public	function	Builds header actions.
ParagraphsWidget::buildModalAddForm	protected	function	Builds an add paragraph button for opening of modal form.
ParagraphsWidget::buildNestedParagraphsFoDragDrop	protected	function	Builds the nested drag and drop structure.
ParagraphsWidget::buildSelectAddMode	protected	function	Builds list of actions based on paragraphs type.
ParagraphsWidget::changeAllEditModeSubmit	public static	function	Loops through all paragraphs and change mode for each paragraph instance.
ParagraphsWidget::createMessage	public	function	Helper to create a paragraph UI message.
ParagraphsWidget::dragDropModeAjax	public static	function	Ajax callback for the dragdrop mode.
ParagraphsWidget::dragDropModeSubmit	public static	function	Sets the form mode accordingly.
ParagraphsWidget::duplicateButtonAccess	protected	function	Check duplicate button access.
ParagraphsWidget::duplicateSubmit	public static	function	Creates a duplicate of the paragraph entity.
ParagraphsWidget::elementValidate	public	function
ParagraphsWidget::errorElement	public	function	Assigns a field-level validation error to the right widget sub-element. Overrides WidgetBase::errorElement
ParagraphsWidget::expandButton	public static	function	Expand button base array into a paragraph widget action button.
ParagraphsWidget::extractFormValues	public	function	Extracts field values from submitted form values. Overrides WidgetBase::extractFormValues
ParagraphsWidget::flagErrors	public	function	Reports field-level validation errors against actual form elements. Overrides WidgetBase::flagErrors
ParagraphsWidget::formElement	public	function	Uses a similar approach to populate a new translation. Overrides WidgetInterface::formElement
ParagraphsWidget::getAccessibleOptions	protected	function	Returns the available paragraphs type.
ParagraphsWidget::getAllowedTypes	public	function	Returns the sorted allowed types for a entity reference field.
ParagraphsWidget::getChildParagraphs	protected	function	Returns a list of child paragraphs for a given field to loop over.
ParagraphsWidget::getDefaultParagraphTypeLabelName	protected	function	Returns the default paragraph type.
ParagraphsWidget::getDefaultParagraphTypeMachineName	protected	function	Returns the machine name for default paragraph type.
ParagraphsWidget::getNumberOfParagraphsInMode	protected	function	Counts the number of paragraphs in a certain mode in a form substructure.
ParagraphsWidget::getSelectionHandlerSetting	protected	function	Returns the value of a setting for the entity reference selection handler.
ParagraphsWidget::getSubmitElementInfo	public static	function	Get common submit element information for processing ajax submit handlers.
ParagraphsWidget::initIsTranslating	protected	function	Determine if widget is in translation.
ParagraphsWidget::isApplicable	public static	function	Returns if the widget can be used for the provided field. Overrides WidgetBase::isApplicable
ParagraphsWidget::isFeatureEnabled	protected	function	Checks if a widget feature is enabled or not.
ParagraphsWidget::itemAjax	public static	function
ParagraphsWidget::massageFormValues	public	function	Massages the form values into the format expected for field values. Overrides WidgetBase::massageFormValues
ParagraphsWidget::multipleElementValidate	public	function	Special handling to validate form elements with multiple values.
ParagraphsWidget::paragraphsItemSubmit	public static	function
ParagraphsWidget::prepareDeltaPosition	protected static	function	Prepares the widget state to add a new paragraph at a specific position.
ParagraphsWidget::removeButtonAccess	protected	function	Check remove button access.
ParagraphsWidget::reorderParagraphs	protected static	function	Reorder paragraphs.
ParagraphsWidget::settingsSummary	public	function	Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
ParagraphsWidget::__construct	public	function	Constructs a ParagraphsWidget object. Overrides WidgetBase::__construct
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::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::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::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

You are here

class ParagraphsBrowserWidget in Paragraphs Browser 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation