You are here

Home » API reference » UI Patterns Settings 8 » CheckboxSettingType.php

class CheckboxSettingType in UI Patterns Settings 8

Checkbox setting type.

Plugin annotation


@UiPatternsSettingType(
  id = "checkbox",
  label = @Translation("Checkboxes")
)

Hierarchy

Expanded class hierarchy of CheckboxSettingType

File

src/Plugin/UiPatterns/SettingType/CheckboxSettingType.php, line 16

Namespace

Drupal\ui_patterns_settings\Plugin\UIPatterns\SettingType
View source 
class CheckboxSettingType extends PatternSettingTypeBase {

  /**
   * {@inheritdoc}
   */
  public function settingsPreprocess($value, array $context, PatternDefinitionSetting $def) {
    $selected_options = [];
    $defined_options = $def
      ->getOptions();
    if (is_array($value)) {
      foreach ($value as $checkbox_key => $checkbox_value) {
        if ($checkbox_value != "0") {
          $selected_options[$checkbox_key] = isset($defined_options[$checkbox_value]) ? $defined_options[$checkbox_value] : $checkbox_value;
        }
      }
    }
    return $selected_options;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, $value, PatternDefinitionSetting $def) {
    $def = $this
      ->getPatternSettingDefinition();
    $value = $this
      ->getValue($value);
    if (is_scalar($value)) {
      $value = [
        $value,
      ];
    }
    if (empty($value)) {
      $value = [];
    }
    $form[$def
      ->getName()] = [
      '#type' => 'checkboxes',
      '#title' => $def
        ->getLabel(),
      '#description' => $def
        ->getDescription(),
      '#default_value' => $value,
      '#required' => $def
        ->getRequired(),
      '#options' => $def
        ->getOptions(),
    ];
    return $form;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CheckboxSettingType::settingsForm public function Returns the configuration form elements specific to this settings plugin.. Overrides PatternSettingTypeInterface::settingsForm
CheckboxSettingType::settingsPreprocess public function Preprocess setting variable. Overrides PatternSettingTypeBase::settingsPreprocess
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PatternSettingTypeBase::$patternSettingDefinition private property Return pattern definitions for setting .
PatternSettingTypeBase::buildConfigurationForm public function Creates a generic configuration form for all settings types. Individual settings plugins can add elements to this form by overriding PatternSettingTypeBaseInterface::settingsForm(). Most plugins should not override this method unless they need to… Overrides PatternSettingTypeInterface::buildConfigurationForm
PatternSettingTypeBase::calculateDependencies public function
PatternSettingTypeBase::create public static function 1
PatternSettingTypeBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
PatternSettingTypeBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
PatternSettingTypeBase::getDescription public function
PatternSettingTypeBase::getPatternSettingDefinition protected function Return pattern setting definition.
PatternSettingTypeBase::getValue protected function Return value if set otherwise take the default value.
PatternSettingTypeBase::label public function
PatternSettingTypeBase::preprocess public function Returns the processed setting variable. Overrides PatternSettingTypeInterface::preprocess 1
PatternSettingTypeBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
PatternSettingTypeBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.