public function EditorSelector::getEditor

Returns the in-place editor (an Editor plugin) to use for a field.

Parameters

string $formatter_type: The field's formatter type name.

\Drupal\field\Plugin\Core\Entity\FieldInstance $instance: The field's instance info.

array $items: The field's item values.

Return value

string|NULL The editor to use, or NULL to not enable in-place editing.

Overrides EditorSelectorInterface::getEditor

File

drupal/core/modules/edit/lib/Drupal/edit/EditorSelector.php, line 46

Contains \Drupal\edit\EditorSelector.

Class

EditorSelector

Selects an in-place editor (an Editor plugin) for a field.

Namespace

Code

public function getEditor($formatter_type, FieldInstance $instance, array $items) {

  // Build a static cache of the editors that have registered themselves as
  // alternatives to a certain editor.
  if (!isset($this->alternatives)) {
    $editors = $this->editorManager
      ->getDefinitions();
    foreach ($editors as $alternative_editor_id => $editor) {
      if (isset($editor['alternativeTo'])) {
        foreach ($editor['alternativeTo'] as $original_editor_id) {
          $this->alternatives[$original_editor_id][] = $alternative_editor_id;
        }
      }
    }
  }

  // Check if the formatter defines an appropriate in-place editor. For
  // example, text formatters displaying untrimmed text can choose to use the
  // 'direct' editor. If the formatter doesn't specify, fall back to the
  // 'form' editor, since that can work for any field. Formatter definitions
  // can use 'disabled' to explicitly opt out of in-place editing.
  $formatter_info = field_info_formatter_types($formatter_type);
  $editor_id = $formatter_info['edit']['editor'];
  if ($editor_id === 'disabled') {
    return;
  }
  elseif ($editor_id === 'form') {
    return 'form';
  }

  // No early return, so create a list of all choices.
  $editor_choices = array(
    $editor_id,
  );
  if (isset($this->alternatives[$editor_id])) {
    $editor_choices = array_merge($editor_choices, $this->alternatives[$editor_id]);
  }

  // Make a choice.
  foreach ($editor_choices as $editor_id) {
    $editor = $this->editorManager
      ->createInstance($editor_id);
    if ($editor
      ->isCompatible($instance, $items)) {
      return $editor_id;
    }
  }

  // We still don't have a choice, so fall back to the default 'form' editor.
  return 'form';
}