interface BUEditorPluginInterface in BUEditor 8.2

Defines an interface for BUEditor plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\bueditor\BUEditorPluginInterface

See also

\Drupal\bueditor\BUEditorPluginBase

\Drupal\bueditor\BUEditorPluginManager

Plugin API

File

src/BUEditorPluginInterface.php, line 17

Namespace

Drupal\bueditor

interface BUEditorPluginInterface extends PluginInspectionInterface {

  /**
   * Returns plugin buttons.
   *
   * @return array
   *   An array of id:label pairs.
   */
  public function getButtons();

  /**
   * Alters JS data of a BUEditor Editor.
   *
   * @param array $js
   *   An associative array that holds 'libraries' and 'settings' of the editor.
   * @param \Drupal\bueditor\Entity\BUEditorEditor $bueditor_editor
   *   BUEditor Editor entity that owns the data.
   * @param \Drupal\editor\Entity\Editor $editor
   *   An optional Editor entity which the BUEditor Editor is attached to.
   */
  public function alterEditorJS(array &$js, BUEditorEditor $bueditor_editor, Editor $editor = NULL);

  /**
   * Alters the toolbar widget used in BUEditor Editor form.
   *
   * @param array $widget
   *   An associative array that holds 'libraries' and 'items' in it.
   */
  public function alterToolbarWidget(array &$widget);

  /**
   * Alters entity form of a BUEditor Editor.
   */
  public function alterEditorForm(array &$form, FormStateInterface $form_state, BUEditorEditor $bueditor_editor);

  /**
   * Validates entity form of a BUEditor Editor.
   */
  public function validateEditorForm(array &$form, FormStateInterface $form_state, BUEditorEditor $bueditor_editor);

}

Members

Name	Modifiers	Type	Description	Overrides
BUEditorPluginInterface::alterEditorForm	public	function	Alters entity form of a BUEditor Editor.	1
BUEditorPluginInterface::alterEditorJS	public	function	Alters JS data of a BUEditor Editor.	1
BUEditorPluginInterface::alterToolbarWidget	public	function	Alters the toolbar widget used in BUEditor Editor form.	1
BUEditorPluginInterface::getButtons	public	function	Returns plugin buttons.	1
BUEditorPluginInterface::validateEditorForm	public	function	Validates entity form of a BUEditor Editor.	1
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2