interface RelationshipInterface in Chaos Tool Suite (ctools) 8.3

Defines an interface for Relationship plugins.

Hierarchy

• interface \Drupal\Core\Plugin\ContextAwarePluginInterface; interface \Drupal\Component\Plugin\DerivativeInspectionInterface
  • interface \Drupal\ctools\Plugin\RelationshipInterface

File

src/Plugin/RelationshipInterface.php, line 11

Namespace

Drupal\ctools\Plugin

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

Name	Modifiers	Type	Description	Overrides
ContextAwarePluginInterface::getContext	public	function	Gets a defined context.	1
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.	1
ContextAwarePluginInterface::getContexts	public	function	Gets the defined contexts.	1
ContextAwarePluginInterface::getContextValue	public	function	Gets the value for a defined context.	1
ContextAwarePluginInterface::getContextValues	public	function	Gets the values for all defined contexts.	1
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.	1
ContextAwarePluginInterface::setContextValue	public	function	Sets the value for a defined context.	1
ContextAwarePluginInterface::validateContexts	public	function	Validates the set values for the defined contexts.	1
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.	4
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.	1
RelationshipInterface::getRelationship	public	function	Generates a context based on this plugin's configuration.	1