class EditorSelector in Zircon Profile 8

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

Hierarchy

• class \Drupal\quickedit\EditorSelector implements EditorSelectorInterface

2 files declare their use of EditorSelector

EditorSelectionTest.php in core/modules/quickedit/src/Tests/EditorSelectionTest.php

Contains \Drupal\quickedit\Tests\EditorSelectionTest.

MetadataGeneratorTest.php in core/modules/quickedit/src/Tests/MetadataGeneratorTest.php

Contains \Drupal\quickedit\Tests\MetadataGeneratorTest.

1 string reference to 'EditorSelector'

quickedit.services.yml in core/modules/quickedit/quickedit.services.yml

core/modules/quickedit/quickedit.services.yml

1 service uses EditorSelector

quickedit.editor.selector in core/modules/quickedit/quickedit.services.yml

Drupal\quickedit\EditorSelector

File

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

Contains \Drupal\quickedit\EditorSelector.

Namespace

Drupal\quickedit

class EditorSelector implements EditorSelectorInterface {

  /**
   * The manager for editor plugins.
   *
   * @var \Drupal\Component\Plugin\PluginManagerInterface
   */
  protected $editorManager;

  /**
   * The manager for formatter plugins.
   *
   * @var \Drupal\Core\Field\FormatterPluginManager.
   */
  protected $formatterManager;

  /**
   * A list of alternative editor plugin IDs, keyed by editor plugin ID.
   *
   * @var array
   */
  protected $alternatives;

  /**
   * Constructs a new EditorSelector.
   *
   * @param \Drupal\Component\Plugin\PluginManagerInterface
   *   The manager for editor plugins.
   * @param \Drupal\Core\Field\FormatterPluginManager
   *   The manager for formatter plugins.
   */
  public function __construct(PluginManagerInterface $editor_manager, FormatterPluginManager $formatter_manager) {
    $this->editorManager = $editor_manager;
    $this->formatterManager = $formatter_manager;
  }

  /**
   * {@inheritdoc}
   */
  public function getEditor($formatter_type, FieldItemListInterface $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
    // '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 = 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($items)) {
        return $editor_id;
      }
    }

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

  /**
   * {@inheritdoc}
   */
  public function getEditorAttachments(array $editor_ids) {
    $attachments = array();
    $editor_ids = array_unique($editor_ids);

    // Editor plugins' attachments.
    foreach ($editor_ids as $editor_id) {
      $editor = $this->editorManager
        ->createInstance($editor_id);
      $attachments[] = $editor
        ->getAttachments();
    }
    return NestedArray::mergeDeepArray($attachments);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EditorSelector::$alternatives	protected	property	A list of alternative editor plugin IDs, keyed by editor plugin ID.
EditorSelector::$editorManager	protected	property	The manager for editor plugins.
EditorSelector::$formatterManager	protected	property	The manager for formatter plugins.
EditorSelector::getEditor	public	function	Returns the in-place editor (an InPlaceEditor plugin) to use for a field. Overrides EditorSelectorInterface::getEditor
EditorSelector::getEditorAttachments	public	function	Returns the attachments for all editors. Overrides EditorSelectorInterface::getEditorAttachments
EditorSelector::__construct	public	function	Constructs a new EditorSelector.