interface RelationshipInterface
Same name in other branches
- 8.x-3.x src/Plugin/RelationshipInterface.php \Drupal\ctools\Plugin\RelationshipInterface
Defines an interface for Relationship plugins.
Hierarchy
- interface \Drupal\Component\Plugin\DerivativeInspectionInterface; interface \Drupal\Core\Plugin\ContextAwarePluginInterface extends \Drupal\Component\Plugin\ContextAwarePluginInterface
- interface \Drupal\ctools\Plugin\RelationshipInterface extends \Drupal\Core\Plugin\ContextAwarePluginInterface \Drupal\Component\Plugin\DerivativeInspectionInterface
Expanded class hierarchy of RelationshipInterface
All classes that implement RelationshipInterface
File
-
src/
Plugin/ RelationshipInterface.php, line 11
Namespace
Drupal\ctools\PluginView source
interface RelationshipInterface extends ContextAwarePluginInterface, DerivativeInspectionInterface {
/**
* Generates a context based on this plugin's configuration.
*
* @return \Drupal\Core\Plugin\Context\ContextInterface
*/
public function getRelationship();
/**
* The name of the property used to get this relationship.
*
* @return string
*/
public function getName();
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ContextAwarePluginInterface::getContext | public | function | Gets a defined context. | ||
ContextAwarePluginInterface::getContextDefinition | public | function | Gets a specific context definition of the plugin. | Overrides ContextAwarePluginInterface::getContextDefinition | |
ContextAwarePluginInterface::getContextDefinitions | public | function | Gets the context definitions of the plugin. | Overrides ContextAwarePluginInterface::getContextDefinitions | |
ContextAwarePluginInterface::getContextMapping | public | function | Gets a mapping of the expected assignment names to their context names. | ||
ContextAwarePluginInterface::getContexts | public | function | Gets the defined contexts. | ||
ContextAwarePluginInterface::getContextValue | public | function | Gets the value for a defined context. | ||
ContextAwarePluginInterface::getContextValues | public | function | Gets the values for all defined contexts. | ||
ContextAwarePluginInterface::setContext | public | function | Set a context on this plugin. | 1 | |
ContextAwarePluginInterface::setContextMapping | public | function | Sets a mapping of the expected assignment names to their context names. | ||
ContextAwarePluginInterface::setContextValue | public | function | Sets the value for a defined context. | ||
ContextAwarePluginInterface::validateContexts | public | function | Validates the set values for the defined contexts. | ||
DerivativeInspectionInterface::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | 1 | |
DerivativeInspectionInterface::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | 1 | |
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 | |
RelationshipInterface::getName | public | function | The name of the property used to get this relationship. | ||
RelationshipInterface::getRelationship | public | function | Generates a context based on this plugin's configuration. |