abstract class DsFieldTemplateBase in Display Suite 8.3
Same name and namespace in other branches
- 8.4 src/Plugin/DsFieldTemplate/DsFieldTemplateBase.php \Drupal\ds\Plugin\DsFieldTemplate\DsFieldTemplateBase
- 8.2 src/Plugin/DsFieldTemplate/DsFieldTemplateBase.php \Drupal\ds\Plugin\DsFieldTemplate\DsFieldTemplateBase
Base class for all the ds plugins.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\ds\Plugin\DsFieldTemplate\DsFieldTemplateBase implements DsFieldTemplateInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of DsFieldTemplateBase
1 file declares its use of DsFieldTemplateBase
- TestLayout.php in tests/
modules/ ds_test/ src/ Plugin/ DsFieldTemplate/ TestLayout.php
File
- src/
Plugin/ DsFieldTemplate/ DsFieldTemplateBase.php, line 12
Namespace
Drupal\ds\Plugin\DsFieldTemplateView source
abstract class DsFieldTemplateBase extends PluginBase implements DsFieldTemplateInterface {
/**
* The entity used for token replacement.
*
* @var \Drupal\Core\Entity\EntityInterface
*/
protected $entity = NULL;
/**
* Constructs a Display Suite field plugin.
*/
public function __construct($configuration, $plugin_id, $plugin_definition) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->configuration += $this
->defaultConfiguration();
}
/**
* {@inheritdoc}
*/
public function getEntity() {
return $this->entity;
}
/**
* {@inheritdoc}
*/
public function setEntity(EntityInterface $entity) {
$this->entity = $entity;
}
/**
* {@inheritdoc}
*/
public function alterForm(&$form) {
$config = $this
->getConfiguration();
$form['lb'] = [
'#type' => 'textfield',
'#title' => $this
->t('Label'),
'#size' => '10',
'#default_value' => $config['lb'],
];
$form['lb-col'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Show label colon'),
'#default_value' => $config['lb-col'],
'#attributes' => [
'class' => [
'colon-checkbox',
],
],
];
$field_classes = Ds::getClasses('field');
if (!empty($field_classes)) {
$form['classes'] = [
'#type' => 'select',
'#multiple' => TRUE,
'#options' => $field_classes,
'#title' => $this
->t('Choose additional CSS classes for the field'),
'#default_value' => $config['classes'],
'#prefix' => '<div class="field-classes">',
'#suffix' => '</div>',
];
}
else {
$form['classes'] = [
'#type' => 'value',
'#value' => [],
];
}
}
/**
* {@inheritdoc}
*/
public function massageRenderValues(&$field_settings, $values) {
if (!empty($values['lb'])) {
$field_settings['lb'] = $values['lb'];
}
if (!empty($values['lb-col'])) {
$field_settings['lb-col'] = TRUE;
}
if (isset($values['classes'])) {
$field_settings['classes'] = $values['classes'];
}
}
/**
* {@inheritdoc}
*/
public function getThemeFunction() {
return $this->pluginDefinition['theme'];
}
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
$config = [];
$config['lb'] = '';
$config['lb-col'] = \Drupal::config('ds.settings')
->get('ft-show-colon');
$config['classes'] = [];
return $config;
}
/**
* {@inheritdoc}
*/
public function getConfiguration() {
return $this->configuration;
}
/**
* {@inheritdoc}
*/
public function setConfiguration(array $configuration) {
$this->configuration = $configuration + $this->configuration;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
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 | |
DsFieldTemplateBase:: |
protected | property | The entity used for token replacement. | |
DsFieldTemplateBase:: |
public | function |
Lets you add you add additional form element for your layout. Overrides DsFieldTemplateInterface:: |
2 |
DsFieldTemplateBase:: |
public | function |
Creates default configuration for the layout. Overrides DsFieldTemplateInterface:: |
2 |
DsFieldTemplateBase:: |
public | function |
Get the selected configuration. Overrides DsFieldTemplateInterface:: |
|
DsFieldTemplateBase:: |
public | function |
Gets the entity this layout belongs too. Overrides DsFieldTemplateInterface:: |
|
DsFieldTemplateBase:: |
public | function |
Gets the chosen theme function. Overrides DsFieldTemplateInterface:: |
|
DsFieldTemplateBase:: |
public | function |
Massages the values before they get rendered. Overrides DsFieldTemplateInterface:: |
2 |
DsFieldTemplateBase:: |
public | function |
Set the configuration for this layout. Overrides DsFieldTemplateInterface:: |
|
DsFieldTemplateBase:: |
public | function |
Sets the entity this layout belong too. Overrides DsFieldTemplateInterface:: |
|
DsFieldTemplateBase:: |
public | function |
Constructs a Display Suite field plugin. Overrides PluginBase:: |
|
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. |