function _gutenberg_text_format_processor in Gutenberg 8

Same name and namespace in other branches

1. 8.2 gutenberg.module \_gutenberg_text_format_processor()

Process the text format element to eliminate the gutenberg format.

On the fields that don't belong to content types with enabled gutenberg experience there is no need to have the gutenberg format.

Parameters

array $element: Render Element.

\Drupal\Core\Form\FormStateInterface $form_state: Form state object.

array $complete_form: Complete form array.

Return value

array Processed render element.

1 string reference to '_gutenberg_text_format_processor'

gutenberg_element_info_alter in ./gutenberg.module

Implements hook_element_info_alter().

File

./gutenberg.module, line 983

Provides integration with the Gutenberg editor.

Code

function _gutenberg_text_format_processor(array $element, FormStateInterface $form_state, array &$complete_form) {

  // Check first if the format is in the list. It might be disabled or the
  // current user has not rights to access it.
  if (!empty($element['format']) && isset($element['format']['format']['#options']['gutenberg'])) {

    // By default let's assume that gutenberg format is not allowed.
    $gutenberg_allowed = FALSE;

    /** @var \Drupal\Core\Entity\ContentEntityForm $form */
    $form = $form_state
      ->getFormObject();

    // Check whether the form that contains the element is an EntityForm.
    if ($form instanceof EntityFormInterface) {

      // Get the entity from the form object for further processing.
      $entity = $form
        ->getEntity();

      // Check whether entity is of node type, because currently only them are
      // supported.
      if ($entity instanceof NodeInterface) {

        // Get the node type to get the Gutenberg experience setting.
        $node_type = $entity
          ->bundle();

        /** @var \Drupal\Core\Config\Config $config */
        $config = \Drupal::service('config.factory')
          ->getEditable('gutenberg.settings');
        $gutenberg_enabled = $config
          ->get($node_type . '_enable_full');
        if (!empty($gutenberg_enabled)) {

          // Gutenberg experience is enabled for current content type and
          // the current user is allowed to use the format.
          $gutenberg_allowed = TRUE;
        }
      }
    }

    // If Gutenberg experience is not enabled for the current form or
    // current user is not allowed to use the format, disable the choice of
    // Gutenberg format for this element.
    if (!$gutenberg_allowed) {
      unset($element['format']['format']['#options']['gutenberg']);
    }
  }
  return $element;
}