class BlockDescription in Display Suite 8.2
Same name and namespace in other branches
- 8.4 src/Plugin/DsField/Block/BlockDescription.php \Drupal\ds\Plugin\DsField\Block\BlockDescription
- 8.3 src/Plugin/DsField/Block/BlockDescription.php \Drupal\ds\Plugin\DsField\Block\BlockDescription
Plugin that renders the title of a block.
Plugin annotation
@DsField(
id = "block_description",
title = @Translation("Description"),
entity_type = "block_content",
provider = "block_content"
)
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 DsFieldInterface
- class \Drupal\ds\Plugin\DsField\Block\BlockDescription
- class \Drupal\ds\Plugin\DsField\DsFieldBase implements DsFieldInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of BlockDescription
File
- src/
Plugin/ DsField/ Block/ BlockDescription.php, line 19
Namespace
Drupal\ds\Plugin\DsField\BlockView source
class BlockDescription extends DsFieldBase {
/**
* {@inheritdoc}
*/
public function build() {
$config = $this
->getConfiguration();
$output = $this
->entity()
->label();
if (empty($output)) {
return array();
}
$output = Html::escape($output);
// Wrapper and class.
if (!empty($config['wrapper'])) {
$wrapper = Html::escape($config['wrapper']);
$class = !empty($config['class']) ? ' class="' . Html::escape($config['class']) . '"' : '';
$output = '<' . $wrapper . $class . '>' . $output . '</' . $wrapper . '>';
}
return array(
'#markup' => $output,
);
}
/**
* {@inheritdoc}
*/
public function settingsForm($form, FormStateInterface $form_state) {
$config = $this
->getConfiguration();
$settings['wrapper'] = array(
'#type' => 'textfield',
'#title' => 'Wrapper',
'#default_value' => $config['wrapper'],
'#description' => $this
->t('Eg: h1, h2, p'),
);
$settings['class'] = array(
'#type' => 'textfield',
'#title' => 'Class',
'#default_value' => $config['class'],
'#description' => $this
->t('Put a class on the wrapper. Eg: block-title'),
);
return $settings;
}
/**
* {@inheritdoc}
*/
public function settingsSummary($settings) {
$config = $this
->getConfiguration();
$summary = array();
$summary[] = 'Wrapper: ' . $config['wrapper'];
if (!empty($config['class'])) {
$summary[] = 'Class: ' . $config['class'];
}
return $summary;
}
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
$configuration = array(
'wrapper' => 'h2',
'class' => '',
);
return $configuration;
}
/**
* {@inheritdoc}
*/
protected function entityRenderKey() {
return 'label';
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BlockDescription:: |
public | function |
Renders a field. Overrides DsFieldBase:: |
|
BlockDescription:: |
public | function |
Gets default configuration for this plugin. Overrides DsFieldBase:: |
|
BlockDescription:: |
protected | function | ||
BlockDescription:: |
public | function |
The form that holds the settings for this plugin. Overrides DsFieldBase:: |
|
BlockDescription:: |
public | function |
Returns the summary of the chosen settings. 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 static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
7 |
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 ConfigurablePluginInterface:: |
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 ConfigurablePluginInterface:: |
1 |
DsFieldBase:: |
public | function |
Gets the view mode. Overrides DsFieldInterface:: |
|
DsFieldBase:: |
public | function |
Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase:: |
8 |
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. |