class Relationship in Chaos Tool Suite (ctools) 8.3
Defines a Relationship item annotation object.
Hierarchy
- class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
- class \Drupal\ctools\Annotation\Relationship
Expanded class hierarchy of Relationship
See also
\Drupal\ctools\Plugin\RelationshipManager
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\AnnotationView 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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Plugin:: |
protected | property | The plugin definition read from the class annotation. | 1 |
Plugin:: |
public | function |
Gets the value of an annotation. Overrides AnnotationInterface:: |
5 |
Plugin:: |
public | function |
Gets the class of the annotated class. Overrides AnnotationInterface:: |
|
Plugin:: |
public | function |
Gets the unique ID for this annotated class. Overrides AnnotationInterface:: |
|
Plugin:: |
public | function |
Gets the name of the provider of the annotated class. Overrides AnnotationInterface:: |
|
Plugin:: |
protected | function | Parses an annotation into its definition. | |
Plugin:: |
public | function |
Sets the class of the annotated class. Overrides AnnotationInterface:: |
|
Plugin:: |
public | function |
Sets the name of the provider of the annotated class. Overrides AnnotationInterface:: |
|
Plugin:: |
public | function | Constructs a Plugin object. | 2 |
Relationship:: |
public | property | The array of contexts requires or optional for this plugin. | |
Relationship:: |
public | property | The returned data type of this relationship. | |
Relationship:: |
public | property | The plugin ID. | |
Relationship:: |
public | property | The label of the plugin. | |
Relationship:: |
public | property | The name of the property from which this relationship is derived. |