1. interface
  2. Drupal
  3. \
  4. ckeditor5
  5. \
  6. Plugin
  7. \
  8. CKEditor5PluginElementsSubsetInterface

CKEditor5PluginElementsSubsetInterface

interface CKEditor5PluginElementsSubsetInterface implements CKEditor5PluginConfigurableInterface (View source)

Defines an interface for plugins that can support an elements subset.

Plugins can support multiple elements in the elements property of their definition. A text format may want to use a given plugin without supporting every supported element. Plugins that implement this interface return a subset based on the configuration in the Text Editor's settings.

Methods

string
getPluginId()

Gets the plugin_id of the plugin instance.

from  PluginInspectionInterface
array
getPluginDefinition()

Gets the definition of the plugin implementation.

from  PluginInspectionInterface
array
getDynamicPluginConfig(array $static_plugin_config, EditorInterface $editor)

Allows a plugin to modify its static configuration.

from  CKEditor5PluginInterface
array
getConfiguration()

Gets this plugin's configuration.

from  ConfigurableInterface
setConfiguration(array $configuration)

Sets the configuration for this plugin instance.

from  ConfigurableInterface
array
defaultConfiguration()

Gets default configuration for this plugin.

from  ConfigurableInterface
array
buildConfigurationForm(array $form, FormStateInterface $form_state)

Form constructor.

from  PluginFormInterface
validateConfigurationForm(array $form, FormStateInterface $form_state)

Form validation handler.

from  PluginFormInterface
submitConfigurationForm(array $form, FormStateInterface $form_state)

Form submission handler.

from  PluginFormInterface
array
getElementsSubset()

Returns a configured subset of the elements supported by this plugin.

Details

in PluginInspectionInterface at line 21
string getPluginId()

Gets the plugin_id of the plugin instance.

Return Value

string

The plugin_id of the plugin instance.

in PluginInspectionInterface at line 30
array getPluginDefinition()

Gets the definition of the plugin implementation.

Return Value

array

The plugin definition, as returned by the discovery object used by the plugin manager.

in CKEditor5PluginInterface at line 37
array getDynamicPluginConfig(array $static_plugin_config, EditorInterface $editor)

Allows a plugin to modify its static configuration.

Parameters

array $static_plugin_config

The ckeditor5.config entry from the YAML or annotation, if any. If none is specified in the YAML or annotation, then the empty array.
EditorInterface $editor

A configured text editor object.

Return Value

array

Returns the received $static_plugin_config plus dynamic additions or alterations.

See also

CKEditor5AspectsOfCKEditor5Plugin::$config
CKEditor5PluginDefinition::getCKEditor5Config

in ConfigurableInterface at line 18
array getConfiguration()

Gets this plugin's configuration.

Return Value

array

An array of this plugin's configuration.

in ConfigurableInterface at line 26
setConfiguration(array $configuration)

Sets the configuration for this plugin instance.

Parameters

array $configuration

An associative array containing the plugin's configuration.

in ConfigurableInterface at line 34
array defaultConfiguration()

Gets default configuration for this plugin.

Return Value

array

An associative array with the default configuration.

in PluginFormInterface at line 41
array buildConfigurationForm(array $form, FormStateInterface $form_state)

Form constructor.

Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and

array_parents, see \Drupal\Core\Render\Element\FormElement.

Parameters

array $form

An associative array containing the initial structure of the plugin form.
FormStateInterface $form_state

The current state of the form. Calling code should pass on a subform state created through \Drupal\Core\Form\SubformState::createForSubform().

Return Value

array

The form structure.

in PluginFormInterface at line 54
validateConfigurationForm(array $form, FormStateInterface $form_state)

Form validation handler.

Parameters

array $form

An associative array containing the structure of the plugin form as built by static::buildConfigurationForm().
FormStateInterface $form_state

The current state of the form. Calling code should pass on a subform state created through \Drupal\Core\Form\SubformState::createForSubform().

in PluginFormInterface at line 67
submitConfigurationForm(array $form, FormStateInterface $form_state)

Form submission handler.

Parameters

array $form

An associative array containing the structure of the plugin form as built by static::buildConfigurationForm().
FormStateInterface $form_state

The current state of the form. Calling code should pass on a subform state created through \Drupal\Core\Form\SubformState::createForSubform().

at line 23
array getElementsSubset()

Returns a configured subset of the elements supported by this plugin.

Return Value

array

An array of supported elements.