1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Plugin
  7. \
  8. PluginWithFormsInterface

PluginWithFormsInterface

interface PluginWithFormsInterface implements PluginInspectionInterface (View source)

Provides an interface for plugins which have forms.

Plugin forms are embeddable forms referenced by the plugin annotation. Used by plugin types which have a larger number of plugin-specific forms.

Methods

string
getPluginId()

Gets the plugin_id of the plugin instance.

from  PluginInspectionInterface
array
getPluginDefinition()

Gets the definition of the plugin implementation.

from  PluginInspectionInterface
string|null
getFormClass(string $operation)

Gets the form class for the given operation.

bool
hasFormClass(string $operation)

Gets whether the plugin has a form class for the given operation.

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.

at line 24
string|null getFormClass(string $operation)

Gets the form class for the given operation.

Parameters

string $operation

The name of the operation.

Return Value

string|null

The form class if defined, NULL otherwise.

at line 35
bool hasFormClass(string $operation)

Gets whether the plugin has a form class for the given operation.

Parameters

string $operation

The name of the operation.

Return Value

bool

TRUE if the plugin has a form class for the given operation.