You are here

RelationshipInterface.php in Chaos Tool Suite (ctools) 8.3

File

src/Plugin/RelationshipInterface.php
View source
<?php

namespace Drupal\ctools\Plugin;

use Drupal\Component\Plugin\DerivativeInspectionInterface;
use Drupal\Core\Plugin\ContextAwarePluginInterface;

/**
 * Defines an interface for Relationship plugins.
 */
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();

}

Interfaces

Namesort descending Description
RelationshipInterface Defines an interface for Relationship plugins.