/home/docs/checkouts/readthedocs.org/user_builds/paragraphs-editor/checkouts/8.x/paragraphs_editor.module

Go to the documentation of this file.

<?php

/**
 * @file
 * Supports editor integration for the paragraphs module.
 */

use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\paragraphs_editor\Utility\RenderUtility;

/**
 * Implements hook_entity_insert().
 */
function paragraphs_editor_entity_insert(EntityInterface $entity) {
  \Drupal::service('paragraphs_editor.edit_buffer.cache')->processDeletionQueue($entity);
}

/**
 * Implements hook_entity_update().
 */
function paragraphs_editor_entity_update(EntityInterface $entity) {
  \Drupal::service('paragraphs_editor.edit_buffer.cache')->processDeletionQueue($entity);
}

/**
 * Implements hook_entity_delete().
 */
function paragraphs_editor_entity_delete(EntityInterface $entity) {
  \Drupal::service('paragraphs_editor.edit_buffer.cache')->processDeletionQueue($entity);
}

/**
 * Implements hook_help().
 */
function paragraphs_editor_help($route_name, RouteMatchInterface $route_match) {
}

/**
 * Implements hook_form_FORM_ID_alter().
 */
function paragraphs_editor_form_field_config_edit_form_alter(&$form, $form_state) {
  $field_definition = $form_state->getBuildInfo()['callback_object']->getEntity();
  if ($field_definition->getType() == 'entity_reference_revisions') {
    $target_type = $field_definition->getFieldStorageDefinition()->getSetting('target_type');
    if ($target_type == 'paragraph') {
      $form['third_party_settings']['paragraphs_editor'] = [
        '#type' => 'fieldset',
        '#title' => t('Paragraphs Editor'),
      ];

      $filter_format_options = [];
      foreach (filter_formats() as $filter_format) {
        $filter_format_options[$filter_format->id()] = $filter_format->label();
      }
      $default_format = $field_definition->getThirdPartySetting('paragraphs_editor', 'filter_format');
      if (!$default_format) {
        $default_format = 'paragraphs_ckeditor';
      }

      $text_bundle_options = \Drupal::service('paragraphs_editor.field_value.manager')->getTextBundles();
      foreach ($text_bundle_options as &$text_bundle_option) {
        $text_bundle_option = $text_bundle_option['label'];
      }
      if (!empty($text_bundle_options) && !empty($filter_format_options)) {
        $form['third_party_settings']['paragraphs_editor'] += [
          '#type' => 'fieldset',
          '#title' => t('Paragraphs Editor'),
          'enabled' => [
            '#type' => 'checkbox',
            '#title' => t('Editor Enabled'),
            '#description' => 'Enables Editor integration for this field.',
            '#default_value' => $field_definition->getThirdPartySetting('paragraphs_editor', 'enabled'),
          ],
          'text_bundle' => [
            '#type' => 'select',
            '#title' => t('Text Bundle'),
            '#description' => t('The bundle to use as text (markup) input.'),
            '#options' => $text_bundle_options,
            '#default_value' => $field_definition->getThirdPartySetting('paragraphs_editor', 'text_bundle'),
            '#element_validate' => [
              'paragraphs_editor_field_config_edit_form_validate',
            ],
            '#states' => [
              'visible' => [
                ':input[name="third_party_settings[paragraphs_editor][enabled]"]' => ['checked' => TRUE],
              ],
            ],
          ],
          'filter_format' => [
            '#type' => 'select',
            '#title' => 'Default Filter Format',
            '#description' => t('The default filter format to use for the editor.'),
            '#options' => $filter_format_options,
            '#default_value' => $default_format,
            '#states' => [
              'visible' => [
                ':input[name="third_party_settings[paragraphs_editor][enabled]"]' => ['checked' => TRUE],
              ],
            ],
          ],
        ];
      }
      else {
        $form['third_party_settings']['paragraphs_editor'] += [
          'message' => [
            '#markup' => '<p>' . t('You must create a paragraph type that includes a single field of type "Text (formatted, long)", and make it available to this field in order to use Editor integration with this field.') . '</p>' .
            '<p>' . t('This type will be used to save plaintext content entered in the wysiwyg.') . '</p>',
          ],
        ];
      }

      $form['#entity_builders'][] = 'paragraphs_editor_field_config_edit_form_builder';
    }
  }
}

/**
 * Form validator for paragraphs editor settings form.
 */
function paragraphs_editor_field_config_edit_form_validate(&$element, $form_state) {
  $parents = $element['#parents'];
  array_pop($parents);
  $settings = $form_state->getValue($parents);

  if (empty($settings['enabled'])) {
    return;
  }

  $text_bundle = $settings['text_bundle'];
  $target_bundles = $form_state->getValue([
    'settings',
    'handler_settings',
    'target_bundles',
  ]);
  if (!$target_bundles || !empty($target_bundles[$text_bundle])) {
    $text_fields = \Drupal::service('paragraphs_editor.field_value.manager')->getTextFields($text_bundle);
    $text_field = reset($text_fields);
    if ($text_field) {
      $parents = array_slice($element['#parents'], 0, -1);
      $parents[] = 'text_field';
      $form_state->setValue($parents, $text_field);
      return;
    }
  }

  $form_state->setError($element, t('Selected text bundle is not allowed.'));
}

/**
 * Entity form builder for paragraphs forms.
 */
function paragraphs_editor_field_config_edit_form_builder($entity_type, $entity, &$form, $form_state) {
  $settings = $form_state->getValue(['third_party_settings', 'paragraphs_editor']);
  if (empty($settings['enabled'])) {
    $entity->unsetThirdPartySetting('paragraphs_editor', 'enabled');
    $entity->unsetThirdPartySetting('paragraphs_editor', 'text_bundle');
    $entity->unsetThirdPartySetting('paragraphs_editor', 'text_field');
    $entity->unsetThirdPartySetting('paragraphs_editor', 'filter_format');
  }
}

/**
 * Implements hook_preprocess_field().
 */
function paragraphs_editor_preprocess_field(&$variables) {
  RenderUtility::preprocessField($variables);
}