thunder_paragraphs.module in Thunder 8.5

Contains paragraphs related hook implementations and functions.

File

modules/thunder_paragraphs/thunder_paragraphs.module

<?php

/**
 * @file
 * Contains paragraphs related hook implementations and functions.
 */
use Drupal\Component\Utility\NestedArray;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Render\Element;
use Drupal\Core\Field\WidgetInterface;
use Drupal\Core\Field\FieldDefinitionInterface;
use Drupal\paragraphs\Plugin\Field\FieldWidget\ParagraphsWidget;

/**
 * Implements hook_field_widget_third_party_settings_form().
 */
function thunder_paragraphs_field_widget_third_party_settings_form(WidgetInterface $plugin, FieldDefinitionInterface $field_definition, $form_mode, $form, FormStateInterface $form_state) {
  $element = [];
  if ($plugin instanceof ParagraphsWidget) {

    // Add library for hard-wiring and disabling options.
    $element['#attached']['library'][] = 'thunder_paragraphs/fieldwidget_settings';
  }
  return $element;
}

/**
 * Implements hook_field_widget_WIDGET_TYPE_form_alter().
 *
 * TODO: Remove in Thunder 4, or when the inline entity form FieldWidgetDisplay
 *       was removed.
 */
function thunder_paragraphs_field_widget_entity_browser_entity_reference_form_alter(&$element, FormStateInterface $form_state, $context) {

  /* @var $context ['widget'] EntityReferenceBrowserWidget */
  if (isset($context['widget']) && $context['widget']
    ->getSetting('field_widget_display') === 'inline_entity_form') {
    \Drupal::messenger()
      ->addWarning(t('The inline_entity_form field widget display is broken and will be removed in Thunder 4.0.0. Please use a different display for your %title field.', [
      '%title' => $element['#title'],
    ]));
    $element['#attach_ief_submit'] = TRUE;
  }
}

/**
 * Implements hook_field_widget_WIDGET_TYPE_form_alter().
 *
 * Used for Classic Paragraphs widget.
 */
function thunder_paragraphs_field_widget_entity_reference_paragraphs_form_alter(&$element, FormStateInterface $form_state, $context) {
  _thunder_paragraph_attach_ief_submit($element, [
    'top',
    'links',
    'collapse_button',
  ]);
}

/**
 * Implements hook_field_widget_WIDGET_TYPE_form_alter().
 *
 * Used for Experimental Paragraphs widget.
 */
function thunder_paragraphs_field_widget_paragraphs_form_alter(&$element, FormStateInterface $form_state, $context) {

  // Based on logic in ParagraphsWidget::formMultipleElements - execution of
  // alter hook for existing paragraphs will be executed first and only with
  // list of editable paragraphs. Since all editable paragraphs are processed
  // before new paragraphs, we can simply disable "Collapse and save" for any
  // following paragraph.
  $processing_new_paragraphs = FALSE;

  /** @var \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem $item */
  foreach ($context['items'] as $item) {
    if ($item
      ->isEmpty()) {
      $processing_new_paragraphs = TRUE;
      break;
    }
  }
  _thunder_paragraph_attach_ief_submit($element, [
    'top',
    'actions',
    'actions',
    'collapse_button',
  ], !$processing_new_paragraphs);
}

/**
 * Helper for attaching IEF submit trigger and functions.
 *
 * @param array $element
 *   Element render array for paragraph.
 * @param array $button_parents
 *   Array with parents for paragraph collapse button.
 * @param bool $is_displayed
 *   Flag if "Collapse and save" button should be visible.
 */
function _thunder_paragraph_attach_ief_submit(array &$element, array $button_parents, $is_displayed = TRUE) {
  if (isset($element['subform'])) {
    foreach (Element::children($element['subform']) as $index) {
      if (isset($element['subform'][$index]['widget'][0]['inline_entity_form']) || isset($element['subform'][$index]['widget']['#ief_id']) || isset($element['subform'][$index]['widget']['#attach_ief_submit'])) {
        $button = NestedArray::getValue($element, $button_parents);
        if ($button) {
          $button['#submit'] = array_merge([
            [
              'Drupal\\inline_entity_form\\ElementSubmit',
              'trigger',
            ],
          ], $button['#submit']);
          $button['#value'] = t('Collapse and save');
          $button['#ief_submit_trigger'] = TRUE;
          $button['#ief_submit_trigger_all'] = TRUE;
          $button['#paragraphs_show_warning'] = FALSE;
          $button['#access'] = $is_displayed;
          NestedArray::setValue($element, $button_parents, $button);
        }
      }
    }
  }
}

Functions

Name	Description
thunder_paragraphs_field_widget_entity_browser_entity_reference_form_alter	Implements hook_field_widget_WIDGET_TYPE_form_alter().
thunder_paragraphs_field_widget_entity_reference_paragraphs_form_alter	Implements hook_field_widget_WIDGET_TYPE_form_alter().
thunder_paragraphs_field_widget_paragraphs_form_alter	Implements hook_field_widget_WIDGET_TYPE_form_alter().
thunder_paragraphs_field_widget_third_party_settings_form	Implements hook_field_widget_third_party_settings_form().
_thunder_paragraph_attach_ief_submit	Helper for attaching IEF submit trigger and functions.