BooleanCheckboxWidget.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/BooleanCheckboxWidget.php
  2. 10 core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/BooleanCheckboxWidget.php
  3. 11.x core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/BooleanCheckboxWidget.php

Namespace

Drupal\Core\Field\Plugin\Field\FieldWidget

File

core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/BooleanCheckboxWidget.php

View source
<?php

namespace Drupal\Core\Field\Plugin\Field\FieldWidget;

use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Field\WidgetBase;
use Drupal\Core\Form\FormStateInterface;

/**
 * Plugin implementation of the 'boolean_checkbox' widget.
 *
 * @FieldWidget(
 *   id = "boolean_checkbox",
 *   label = @Translation("Single on/off checkbox"),
 *   field_types = {
 *     "boolean"
 *   },
 *   multiple_values = TRUE
 * )
 */
class BooleanCheckboxWidget extends WidgetBase {
    
    /**
     * {@inheritdoc}
     */
    public static function defaultSettings() {
        return [
            'display_label' => TRUE,
        ] + parent::defaultSettings();
    }
    
    /**
     * {@inheritdoc}
     */
    public function settingsForm(array $form, FormStateInterface $form_state) {
        $element['display_label'] = [
            '#type' => 'checkbox',
            '#title' => t('Use field label instead of the "On" label as the label.'),
            '#default_value' => $this->getSetting('display_label'),
            '#weight' => -1,
        ];
        return $element;
    }
    
    /**
     * {@inheritdoc}
     */
    public function settingsSummary() {
        $summary = [];
        $display_label = $this->getSetting('display_label');
        $summary[] = t('Use field label: @display_label', [
            '@display_label' => $display_label ? t('Yes') : t('No'),
        ]);
        return $summary;
    }
    
    /**
     * {@inheritdoc}
     */
    public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
        $element['value'] = $element + [
            '#type' => 'checkbox',
            '#default_value' => !empty($items[0]->value),
        ];
        // Override the title from the incoming $element.
        if ($this->getSetting('display_label')) {
            $element['value']['#title'] = $this->fieldDefinition
                ->getLabel();
        }
        else {
            $element['value']['#title'] = $this->fieldDefinition
                ->getSetting('on_label');
        }
        return $element;
    }

}

Classes

Title Deprecated Summary
BooleanCheckboxWidget Plugin implementation of the 'boolean_checkbox' widget.

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