class BooleanFormatter in Drupal 10
Same name and namespace in other branches
- 8 core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/BooleanFormatter.php \Drupal\Core\Field\Plugin\Field\FieldFormatter\BooleanFormatter
- 9 core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/BooleanFormatter.php \Drupal\Core\Field\Plugin\Field\FieldFormatter\BooleanFormatter
Plugin implementation of the 'boolean' formatter.
Plugin annotation
@FieldFormatter(
id = "boolean",
label = @Translation("Boolean"),
field_types = {
"boolean",
}
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Field\Plugin\Field\FieldFormatter\BooleanFormatter
- class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of BooleanFormatter
File
- core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldFormatter/ BooleanFormatter.php, line 20
Namespace
Drupal\Core\Field\Plugin\Field\FieldFormatterView source
class BooleanFormatter extends FormatterBase {
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
$settings = [];
// Fall back to field settings by default.
$settings['format'] = 'default';
$settings['format_custom_false'] = '';
$settings['format_custom_true'] = '';
return $settings;
}
/**
* Gets the available format options.
*
* @return array|string
* A list of output formats. Each entry is keyed by the machine name of the
* format. The value is an array, of which the first item is the result for
* boolean TRUE, the second is for boolean FALSE. The value can be also an
* array, but this is just the case for the custom format.
*/
protected function getOutputFormats() {
$formats = [
'default' => [
$this
->getFieldSetting('on_label'),
$this
->getFieldSetting('off_label'),
],
'yes-no' => [
$this
->t('Yes'),
$this
->t('No'),
],
'true-false' => [
$this
->t('True'),
$this
->t('False'),
],
'on-off' => [
$this
->t('On'),
$this
->t('Off'),
],
'enabled-disabled' => [
$this
->t('Enabled'),
$this
->t('Disabled'),
],
'boolean' => [
1,
0,
],
'unicode-yes-no' => [
'✔',
'✖',
],
'custom' => $this
->t('Custom'),
];
return $formats;
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$form = parent::settingsForm($form, $form_state);
$formats = [];
foreach ($this
->getOutputFormats() as $format_name => $format) {
if (is_array($format)) {
if ($format_name == 'default') {
$formats[$format_name] = $this
->t('Field settings (@on_label / @off_label)', [
'@on_label' => $format[0],
'@off_label' => $format[1],
]);
}
else {
$formats[$format_name] = $this
->t('@on_label / @off_label', [
'@on_label' => $format[0],
'@off_label' => $format[1],
]);
}
}
else {
$formats[$format_name] = $format;
}
}
$field_name = $this->fieldDefinition
->getName();
$form['format'] = [
'#type' => 'select',
'#title' => $this
->t('Output format'),
'#default_value' => $this
->getSetting('format'),
'#options' => $formats,
];
$form['format_custom_true'] = [
'#type' => 'textfield',
'#title' => $this
->t('Custom output for TRUE'),
'#default_value' => $this
->getSetting('format_custom_true'),
'#states' => [
'visible' => [
'select[name="fields[' . $field_name . '][settings_edit_form][settings][format]"]' => [
'value' => 'custom',
],
],
],
];
$form['format_custom_false'] = [
'#type' => 'textfield',
'#title' => $this
->t('Custom output for FALSE'),
'#default_value' => $this
->getSetting('format_custom_false'),
'#states' => [
'visible' => [
'select[name="fields[' . $field_name . '][settings_edit_form][settings][format]"]' => [
'value' => 'custom',
],
],
],
];
return $form;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
$summary = [];
$setting = $this
->getSetting('format');
if ($setting == 'custom') {
$summary[] = $this
->t('Custom text: @true_label / @false_label', [
'@true_label' => $this
->getSetting('format_custom_true'),
'@false_label' => $this
->getSetting('format_custom_false'),
]);
}
else {
$formats = $this
->getOutputFormats();
$summary[] = $this
->t('Display: @true_label / @false_label', [
'@true_label' => $formats[$setting][0],
'@false_label' => $formats[$setting][1],
]);
}
return $summary;
}
/**
* {@inheritdoc}
*/
public function viewElements(FieldItemListInterface $items, $langcode) {
$elements = [];
$formats = $this
->getOutputFormats();
foreach ($items as $delta => $item) {
$format = $this
->getSetting('format');
if ($format == 'custom') {
$elements[$delta] = [
'#markup' => $item->value ? $this
->getSetting('format_custom_true') : $this
->getSetting('format_custom_false'),
];
}
else {
$elements[$delta] = [
'#markup' => $item->value ? $formats[$format][0] : $formats[$format][1],
];
}
}
return $elements;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BooleanFormatter:: |
public static | function |
Defines the default settings for this plugin. Overrides PluginSettingsBase:: |
|
BooleanFormatter:: |
protected | function | Gets the available format options. | |
BooleanFormatter:: |
public | function |
Returns a form to configure settings for the formatter. Overrides FormatterBase:: |
|
BooleanFormatter:: |
public | function |
Returns a short summary for the current formatter settings. Overrides FormatterBase:: |
|
BooleanFormatter:: |
public | function |
Builds a renderable array for a field value. Overrides FormatterInterface:: |
|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormatterBase:: |
protected | property | The field definition. | |
FormatterBase:: |
protected | property | The label display setting. | |
FormatterBase:: |
protected | property |
The formatter settings. Overrides PluginSettingsBase:: |
|
FormatterBase:: |
protected | property | The view mode. | |
FormatterBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
12 |
FormatterBase:: |
protected | function | Returns the value of a field setting. | |
FormatterBase:: |
protected | function | Returns the array of field settings. | |
FormatterBase:: |
public static | function |
Returns if the formatter can be used for the provided field. Overrides FormatterInterface:: |
13 |
FormatterBase:: |
public | function |
Allows formatters to load information for field values being displayed. Overrides FormatterInterface:: |
2 |
FormatterBase:: |
public | function |
Builds a renderable array for a fully themed field. Overrides FormatterInterface:: |
1 |
FormatterBase:: |
public | function |
Constructs a FormatterBase object. Overrides PluginBase:: |
12 |
MessengerTrait:: |
protected | property | The messenger. | 18 |
MessengerTrait:: |
public | function | Gets the messenger. | 18 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | |
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 | ||
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | 2 | |
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginSettingsBase:: |
protected | property | Whether default settings have been merged into the current $settings. | |
PluginSettingsBase:: |
protected | property | The plugin settings injected by third party modules. | |
PluginSettingsBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
5 |
PluginSettingsBase:: |
public | function |
Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
protected | function | Merges default settings values into $settings. | |
PluginSettingsBase:: |
public | function |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface:: |
2 |
PluginSettingsBase:: |
public | function |
Sets the value of a setting for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the settings for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 3 |
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. | 1 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |