class BundleField in Display Suite 8.3
Same name in this branch
- 8.3 src/Plugin/Derivative/BundleField.php \Drupal\ds\Plugin\Derivative\BundleField
- 8.3 src/Plugin/DsField/BundleField.php \Drupal\ds\Plugin\DsField\BundleField
Same name and namespace in other branches
- 8.4 src/Plugin/DsField/BundleField.php \Drupal\ds\Plugin\DsField\BundleField
- 8.2 src/Plugin/DsField/BundleField.php \Drupal\ds\Plugin\DsField\BundleField
Defines a generic bundle field.
Plugin annotation
@DsField(
id = "bundle_field",
deriver = "Drupal\ds\Plugin\Derivative\BundleField"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\ds\Plugin\DsField\DsFieldBase implements ConfigurableInterface, DependentPluginInterface, DsFieldInterface
- class \Drupal\ds\Plugin\DsField\BundleField
- class \Drupal\ds\Plugin\DsField\DsFieldBase implements ConfigurableInterface, DependentPluginInterface, DsFieldInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of BundleField
File
- src/
Plugin/ DsField/ BundleField.php, line 16
Namespace
Drupal\ds\Plugin\DsFieldView source
class BundleField extends DsFieldBase {
/**
* The EntityDisplayRepository service.
*
* @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
*/
protected $entityTypeBundleInfo;
/**
* Constructs a Display Suite field plugin.
*
* @param $configuration
* @param $plugin_id
* @param $plugin_definition
* @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
*/
public function __construct($configuration, $plugin_id, $plugin_definition, EntityTypeBundleInfoInterface $entity_type_bundle_info) {
$this->entityTypeBundleInfo = $entity_type_bundle_info;
parent::__construct($configuration, $plugin_id, $plugin_definition);
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('entity_type.bundle.info'));
}
/**
* {@inheritdoc}
*/
public function build() {
$config = $this
->getConfiguration();
$entity = $this
->entity();
$bundles_info = $this->entityTypeBundleInfo
->getBundleInfo($config['field']['entity_type']);
$output = $bundles_info[$entity
->bundle()]['label'];
return [
'#markup' => $output,
];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BundleField:: |
protected | property | The EntityDisplayRepository service. | |
BundleField:: |
public | function |
Renders a field. Overrides DsFieldBase:: |
|
BundleField:: |
public static | function |
Creates an instance of the plugin. Overrides DsFieldBase:: |
|
BundleField:: |
public | function |
Constructs a Display Suite field plugin. Overrides DsFieldBase:: |
|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
DsFieldBase:: |
public | function |
Gets the current bundle. Overrides DsFieldInterface:: |
|
DsFieldBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
|
DsFieldBase:: |
public | function |
Gets default configuration for this plugin. Overrides ConfigurableInterface:: |
6 |
DsFieldBase:: |
public | function |
Gets the current entity. Overrides DsFieldInterface:: |
|
DsFieldBase:: |
public | function |
Returns a list of possible formatters for this field. Overrides DsFieldInterface:: |
4 |
DsFieldBase:: |
public | function |
Gets this plugin's configuration. Overrides ConfigurableInterface:: |
1 |
DsFieldBase:: |
public | function |
Gets the current entity type. Overrides DsFieldInterface:: |
|
DsFieldBase:: |
public | function |
Gets the field configuration. Overrides DsFieldInterface:: |
|
DsFieldBase:: |
public | function |
Gets the field name. Overrides DsFieldInterface:: |
|
DsFieldBase:: |
public | function |
Returns the title of the field. Overrides DsFieldInterface:: |
1 |
DsFieldBase:: |
public | function |
Returns if the field is allowed on the field UI screen. Overrides DsFieldInterface:: |
4 |
DsFieldBase:: |
public | function |
Defines if we are dealing with a multivalue field. Overrides DsFieldInterface:: |
1 |
DsFieldBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurableInterface:: |
1 |
DsFieldBase:: |
public | function |
The form that holds the settings for this plugin. Overrides DsFieldInterface:: |
8 |
DsFieldBase:: |
public | function |
Returns the summary of the chosen settings. Overrides DsFieldInterface:: |
7 |
DsFieldBase:: |
public | function |
Gets the view mode. Overrides DsFieldInterface:: |
|
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |