class DsField in Display Suite 8.3
Same name and namespace in other branches
- 8.4 src/Annotation/DsField.php \Drupal\ds\Annotation\DsField
- 8.2 src/Annotation/DsField.php \Drupal\ds\Annotation\DsField
Defines a DsField annotation object.
Hierarchy
- class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
- class \Drupal\ds\Annotation\DsField
Expanded class hierarchy of DsField
42 classes are annotated with DsField
- BlockDescription in src/
Plugin/ DsField/ Block/ BlockDescription.php - Plugin that renders the title of a block.
- BlockTitle in src/
Plugin/ DsField/ Block/ BlockTitle.php - Plugin that renders the title of a block.
- BookNavigation in src/
Plugin/ DsField/ Book/ BookNavigation.php - Plugin that the book navigation.
- BundleField in src/
Plugin/ DsField/ BundleField.php - Defines a generic bundle field.
- CommentAuthor in src/
Plugin/ DsField/ Comment/ CommentAuthor.php - Plugin that renders the author of a comment.
File
- src/
Annotation/ DsField.php, line 12
Namespace
Drupal\ds\AnnotationView source
class DsField extends Plugin {
/**
* The plugin ID.
*
* @var string
*/
public $id;
/**
* The human-readable name of the DS plugin.
*
* @var \Drupal\Core\Annotation\Translation
*
* @ingroup plugin_translatable
*/
public $title;
/**
* The entity type this plugin should work on.
*
* @var string|array
*/
public $entity_type;
/**
* An array of limits for showing this field.
*
* In the format: "bundle|view_mode".
*
* @var array
*/
public $ui_limit;
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DsField:: |
public | property | The entity type this plugin should work on. | |
DsField:: |
public | property | The plugin ID. | |
DsField:: |
public | property | The human-readable name of the DS plugin. | |
DsField:: |
public | property | An array of limits for showing this field. | |
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 |