function EditorSelector::getEditor

Same name in other branches
  1. 8.9.x core/modules/quickedit/src/EditorSelector.php \Drupal\quickedit\EditorSelector::getEditor()

Overrides EditorSelectorInterface::getEditor

File

core/modules/quickedit/src/EditorSelector.php, line 52

Class

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

Namespace

Drupal\quickedit

Code

public function getEditor($formatter_type, FieldItemListInterface $items) {
    // Check if the formatter defines an appropriate in-place editor. For
    // example, text formatters displaying plain text can choose to use the
    // 'plain_text' 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 = $this->formatterManager
        ->getDefinition($formatter_type);
    $editor_id = $formatter_info['quickedit']['editor'];
    if ($editor_id === 'disabled') {
        return;
    }
    elseif ($editor_id === 'form') {
        return 'form';
    }
    // No early return, so create a list of all choices.
    $editor_choices = [
        $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($items)) {
            return $editor_id;
        }
    }
    // We still don't have a choice, so fall back to the default 'form' editor.
    return 'form';
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.