RelationshipInterface.php

Same filename in other branches
  1. 4.0.x src/Plugin/RelationshipInterface.php

Namespace

Drupal\ctools\Plugin

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

Title Deprecated Summary
RelationshipInterface Defines an interface for Relationship plugins.