class WysiwygEditor

Defines the wysiwyg editor.

Plugin annotation


@InPlaceEditor(
  id = "wysiwyg",
  alternativeTo = {"direct"}
)

Hierarchy

Expanded class hierarchy of WysiwygEditor

File

drupal/core/modules/edit/tests/modules/lib/Drupal/edit_test/Plugin/InPlaceEditor/WysiwygEditor.php, line 22
Contains \Drupal\edit_test\Plugin\InPlaceEditor\WysiwygEditor.

Namespace

Drupal\edit_test\Plugin\InPlaceEditor
View source
class WysiwygEditor extends EditorBase {

  /**
   * Implements \Drupal\edit\EditPluginInterface::isCompatible().
   */
  function isCompatible(FieldInstance $instance, array $items) {
    $field = field_info_field($instance['field_name']);

    // This editor is incompatible with multivalued fields.
    if ($field['cardinality'] != 1) {
      return FALSE;
    }
    elseif (!empty($instance['settings']['text_processing'])) {
      $format_id = $items[0]['format'];
      if (isset($format_id) && $format_id === 'full_html') {
        return TRUE;
      }
      return FALSE;
    }
  }

  /**
   * Implements \Drupal\edit\EditPluginInterface::getMetadata().
   */
  function getMetadata(FieldInstance $instance, array $items) {
    $format_id = $items[0]['format'];
    $metadata['format'] = $format_id;
    return $metadata;
  }

  /**
   * Implements \Drupal\edit\EditPluginInterface::getAttachments().
   */
  public function getAttachments() {
    return array(
      'library' => array(
        array(
          'edit_test',
          'not-existing-wysiwyg',
        ),
      ),
    );
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::getPluginDefinition public function Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::__construct public function Constructs a Drupal\Component\Plugin\PluginBase object. 17
WysiwygEditor::getAttachments public function Implements \Drupal\edit\EditPluginInterface::getAttachments(). Overrides EditPluginInterface::getAttachments
WysiwygEditor::getMetadata function Implements \Drupal\edit\EditPluginInterface::getMetadata(). Overrides EditorBase::getMetadata
WysiwygEditor::isCompatible function Implements \Drupal\edit\EditPluginInterface::isCompatible(). Overrides EditPluginInterface::isCompatible