You are here

Home » API reference » Paragraphs table 8 » ParagraphsTableWidget.php

class ParagraphsTableWidget in Paragraphs table 8

Plugin implementation of the 'paragraphs_table_widget' widget.

Plugin annotation


@FieldWidget(
  id = "paragraphs_table_widget",
  label = @Translation("Paragraphs table"),
  description = @Translation("Paragraphs table form widget."),
  field_types = {
    "entity_reference_revisions"
  }
)

Hierarchy

Expanded class hierarchy of ParagraphsTableWidget

File

src/Plugin/Field/FieldWidget/ParagraphsTableWidget.php, line 22

Namespace

Drupal\paragraphs_table\Plugin\Field\FieldWidget
View source 
class ParagraphsTableWidget extends ParagraphsWidget {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'vertical' => FALSE,
      'paste_clipboard' => FALSE,
      'show_all' => FALSE,
      'duplicate' => FALSE,
      'features' => [
        'duplicate' => 'duplicate',
      ],
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = [];
    $elements['vertical'] = [
      '#type' => 'checkbox',
      '#title' => t('Table vertical'),
      '#description' => t('If checked, table data will show in vertical mode.'),
      '#default_value' => !empty($this
        ->getSetting('vertical')) ? $this
        ->getSetting('vertical') : FALSE,
    ];
    $elements['paste_clipboard'] = [
      '#type' => 'checkbox',
      '#title' => t('Paste from clipboard'),
      '#description' => t('Add multiple rows, you can paste data from Excel'),
      '#default_value' => !empty($this
        ->getSetting('paste_clipboard')) ? $this
        ->getSetting('paste_clipboard') : FALSE,
    ];
    $cardinality = $this->fieldDefinition
      ->get('fieldStorage')
      ->get('cardinality');
    if ($cardinality > 1) {
      $elements['show_all'] = [
        '#type' => 'checkbox',
        '#title' => t('Show all %cardinality items in form', [
          '%cardinality' => $cardinality,
        ]),
        '#description' => t('If checked, remove button add more.'),
        '#default_value' => !empty($this
          ->getSetting('show_all')) ? $this
          ->getSetting('show_all') : FALSE,
      ];
    }
    if (!in_array($cardinality, range(0, 3))) {
      $elements['features'] = [
        '#type' => 'checkboxes',
        '#title' => $this
          ->t('Enable widget features'),
        '#options' => [
          'duplicate' => $this
            ->t('Duplicate'),
        ],
        '#default_value' => $this
          ->getSetting('features'),
        '#multiple' => TRUE,
      ];
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    if (!empty($this
      ->getSetting('vertical'))) {
      $summary[] = t('Table mode vertical');
    }
    if (!empty($this
      ->getSetting('paste_clipboard'))) {
      $summary[] = t('Paste from Excel');
    }
    if (!empty($this
      ->getSetting('show_all'))) {
      $cardinality = $this->fieldDefinition
        ->get('fieldStorage')
        ->get('cardinality');
      $summary[] = t('Show all %cardinality elements in form', [
        '%cardinality' => $cardinality,
      ]);
    }
    $features = array_filter($this
      ->getSetting('features'));
    if (!empty($features)) {
      $summary[] = $this
        ->t('Features: @features', [
        '@features' => implode(', ', $features),
      ]);
    }
    return $summary;
  }

  /**
   * For multiple elements.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function formMultipleElements(FieldItemListInterface $items, array &$form, FormStateInterface $form_state) {
    $elements = parent::formMultipleElements($items, $form, $form_state);
    $target_type = $this
      ->getFieldSetting('target_type');
    $default_type = $this
      ->getDefaultParagraphTypeMachineName();
    $field_name = $this->fieldDefinition
      ->getName();
    $widgetState = static::getWidgetState($this->fieldParents, $field_name, $form_state);
    $widgetState["paragraphs"][0]["mode"] = 'edit';
    $elements["#paragraphsTable"]["#widget_state"] = $widgetState;
    $elements["#paragraphsTable"]["#table_vertical"] = $this
      ->getSetting('vertical');
    $elements["#paragraphsTable"]["#paste_clipboard"] = $this
      ->getSetting('paste_clipboard');
    $elements["#paragraphsTable"]["#show_all"] = $this
      ->getSetting('show_all');
    $elements["#paragraphsTable"]["#feature"] = $this
      ->getSetting('features');
    if (empty($default_type)) {
      $default_type = array_key_first($this
        ->getAllowedTypes());
    }
    if (empty($default_type)) {
      return $elements;
    }
    $formDisplay = \Drupal::service('entity_display.repository')
      ->getFormDisplay($target_type, $default_type);
    $components = $formDisplay
      ->getComponents();
    uasort($components, 'Drupal\\Component\\Utility\\SortArray::sortByWeightElement');

    /** @var \Drupal\paragraphs\ParagraphInterface $paragraphs_entity */
    $paragraphs_entity = \Drupal::entityTypeManager()
      ->getStorage($target_type)
      ->create([
      'type' => $default_type,
    ]);
    $field_definitions = $paragraphs_entity
      ->getFieldDefinitions();
    foreach ($components as $name => $setting) {
      if (!empty($field_definitions[$name]) && $field_definitions[$name] instanceof FieldConfigInterface) {
        $elements["#paragraphsTable"]['#fields'][$name] = $field_definitions[$name];
      }
    }
    return $elements;
  }

}

Members

Namesort descending 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.
ParagraphsTableWidget::defaultSettings public static function Defines the default settings for this plugin. Overrides ParagraphsWidget::defaultSettings
ParagraphsTableWidget::formMultipleElements public function For multiple elements. Overrides ParagraphsWidget::formMultipleElements
ParagraphsTableWidget::settingsForm public function Returns a form to configure settings for the widget. Overrides ParagraphsWidget::settingsForm
ParagraphsTableWidget::settingsSummary public function Returns a short summary for the current widget settings. Overrides ParagraphsWidget::settingsSummary
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::form public function Creates a form element for a field. Overrides WidgetBase::form
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::getSettingOptions protected function Returns select options for a plugin setting.
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::__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