class Relationship

Same name and namespace in other branches
  1. 8.x-3.x src/Annotation/Relationship.php \Drupal\ctools\Annotation\Relationship

Defines a Relationship item annotation object.

Hierarchy

Expanded class hierarchy of Relationship

See also

\Drupal\ctools\Plugin\RelationshipManager

Plugin API

1 string reference to 'Relationship'
ctools.schema.yml in config/schema/ctools.schema.yml
config/schema/ctools.schema.yml
3 classes are annotated with Relationship
TypedDataEntityRelationship in src/Plugin/Relationship/TypedDataEntityRelationship.php
Plugin annotation @Relationship( id = "typed_data_entity_relationship", deriver = "\Drupal\ctools\Plugin\Deriver\TypedDataEntityRelationshipDeriver" )
TypedDataLanguageRelationship in src/Plugin/Relationship/TypedDataLanguageRelationship.php
Plugin annotation @Relationship( id = "typed_data_language_relationship", deriver = "\Drupal\ctools\Plugin\Deriver\TypedDataLanguageRelationshipDeriver" )
TypedDataRelationship in src/Plugin/Relationship/TypedDataRelationship.php
Plugin annotation @Relationship( id = "typed_data_relationship", deriver = "\Drupal\ctools\Plugin\Deriver\TypedDataRelationshipDeriver" )

File

src/Annotation/Relationship.php, line 15

Namespace

Drupal\ctools\Annotation
View source 
class Relationship extends Plugin {
    
    /**
     * The plugin ID.
     *
     * @var string
     */
    public $id;
    
    /**
     * The label of the plugin.
     *
     * @var \Drupal\Core\Annotation\Translation
     *
     * @ingroup plugin_translatable
     */
    public $label;
    
    /**
     * The returned data type of this relationship.
     *
     * @var string
     */
    public $data_type;
    
    /**
     * The name of the property from which this relationship is derived.
     *
     * @var string
     */
    public $property_name;
    
    /**
     * The array of contexts requires or optional for this plugin.
     *
     * @var \Drupal\Core\Plugin\Context\ContextInterface[]
     */
    public $context;

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
Plugin::$definition protected property The plugin definition read from the class annotation. 1
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get 6
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass 1
Plugin::getId public function Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider public function Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider 1
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass 1
Plugin::setProvider public function Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct public function Constructs a Plugin object. 3
Relationship::$context public property The array of contexts requires or optional for this plugin.
Relationship::$data_type public property The returned data type of this relationship.
Relationship::$id public property The plugin ID.
Relationship::$label public property The label of the plugin.
Relationship::$property_name public property The name of the property from which this relationship is derived.