class BooleanFormatter

Same name in other branches
  1. 9 core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/BooleanFormatter.php \Drupal\Core\Field\Plugin\Field\FieldFormatter\BooleanFormatter
  2. 8.9.x core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/BooleanFormatter.php \Drupal\Core\Field\Plugin\Field\FieldFormatter\BooleanFormatter
  3. 11.x core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/BooleanFormatter.php \Drupal\Core\Field\Plugin\Field\FieldFormatter\BooleanFormatter

Plugin implementation of the 'boolean' formatter.

Hierarchy

Expanded class hierarchy of BooleanFormatter

File

core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/BooleanFormatter.php, line 14

Namespace

Drupal\Core\Field\Plugin\Field\FieldFormatter
View 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

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
BooleanFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
BooleanFormatter::getOutputFormats protected function Gets the available format options.
BooleanFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
BooleanFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
BooleanFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 13
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 12
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
FormatterBase::__construct public function Constructs a FormatterBase object. 13
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.