interface TcaPluginInterface in Token Content Access 2.0.x
Same name and namespace in other branches
- 8 src/Plugin/TcaPluginInterface.php \Drupal\tca\Plugin\TcaPluginInterface
Defines an interface for TCA plugins.
Hierarchy
- interface \Drupal\Component\Plugin\PluginInspectionInterface
- interface \Drupal\tca\Plugin\TcaPluginInterface
Expanded class hierarchy of TcaPluginInterface
All classes that implement TcaPluginInterface
File
- src/
Plugin/ TcaPluginInterface.php, line 10
Namespace
Drupal\tca\PluginView source
interface TcaPluginInterface extends PluginInspectionInterface {
/**
* The fildable mark.
*
* Return TRUE if will the settings be stored in fields,
* otherwise, settings will be stored in config.
*
* @return bool
* The fildable mark.
*/
public function isFieldable();
/**
* Return locations to attach submit handlers to entities.
*
* This should return an array of arrays, e.g.:
* [
* ['actions', 'submit', '#publish'],
* ['actions', 'publish', '#submit'],
* ].
*/
public function getFormSubmitHandlerAttachLocations();
/**
* Return locations to attach submit handlers to entity bundles.
*
* This should return an array of arrays, e.g.:
* [
* ['actions', 'submit', '#publish'],
* ['actions', 'publish', '#submit'],
* ].
*
* @return array
* A multidimensional array.
*/
public function getBundleFormSubmitHandlerAttachLocations();
/**
* Return a map of entity IDs used by this plugin to token IDs.
*
* @return array
* A map of token IDs to entity IDs in the form
* ['entity ID' => 'token ID']
*/
public function getEntityTokenMap();
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
PluginInspectionInterface:: |
public | function | Gets the definition of the plugin implementation. | 4 |
PluginInspectionInterface:: |
public | function | Gets the plugin_id of the plugin instance. | 2 |
TcaPluginInterface:: |
public | function | Return locations to attach submit handlers to entity bundles. | 1 |
TcaPluginInterface:: |
public | function | Return a map of entity IDs used by this plugin to token IDs. | 1 |
TcaPluginInterface:: |
public | function | Return locations to attach submit handlers to entities. | 1 |
TcaPluginInterface:: |
public | function | The fildable mark. | 1 |