interface InPlaceEditorInterface
Same name in other branches
- 8.9.x core/modules/quickedit/src/Plugin/InPlaceEditorInterface.php \Drupal\quickedit\Plugin\InPlaceEditorInterface
Defines an interface for in-place editors plugins.
Hierarchy
- interface \Drupal\Component\Plugin\PluginInspectionInterface
- interface \Drupal\quickedit\Plugin\InPlaceEditorInterface extends \Drupal\Component\Plugin\PluginInspectionInterface
Expanded class hierarchy of InPlaceEditorInterface
All classes that implement InPlaceEditorInterface
See also
\Drupal\quickedit\Annotation\InPlaceEditor
\Drupal\quickedit\Plugin\InPlaceEditorBase
\Drupal\quickedit\Plugin\InPlaceEditorManager
2 files declare their use of InPlaceEditorInterface
- Editor.php in core/
modules/ quickedit/ src/ Plugin/ InPlaceEditor/ Editor.php - Editor.php in core/
modules/ editor/ src/ Plugin/ InPlaceEditor/ Editor.php
File
-
core/
modules/ quickedit/ src/ Plugin/ InPlaceEditorInterface.php, line 16
Namespace
Drupal\quickedit\PluginView source
interface InPlaceEditorInterface extends PluginInspectionInterface {
/**
* Checks whether this in-place editor is compatible with a given field.
*
* @param \Drupal\Core\Field\FieldItemListInterface $items
* The field values to be in-place edited.
*
* @return bool
* TRUE if it is compatible, FALSE otherwise.
*/
public function isCompatible(FieldItemListInterface $items);
/**
* Generates metadata that is needed specifically for this editor.
*
* Will only be called by \Drupal\quickedit\MetadataGeneratorInterface::generate()
* when the passed in field & item values will use this editor.
*
* @param \Drupal\Core\Field\FieldItemListInterface $items
* The field values to be in-place edited.
*
* @return array
* A keyed array with metadata. Each key should be prefixed with the plugin
* ID of the editor.
*/
public function getMetadata(FieldItemListInterface $items);
/**
* Returns the attachments for this editor.
*
* @return array
* An array of attachments, for use with #attached.
*
* @see \Drupal\Core\Render\AttachmentsResponseProcessorInterface::processAttachments()
*/
public function getAttachments();
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
InPlaceEditorInterface::getAttachments | public | function | Returns the attachments for this editor. | 7 |
InPlaceEditorInterface::getMetadata | public | function | Generates metadata that is needed specifically for this editor. | 3 |
InPlaceEditorInterface::isCompatible | public | function | Checks whether this in-place editor is compatible with a given field. | 7 |
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin_id of the plugin instance. | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.