You are here

Home » API reference » UI Patterns Settings 8.2 » EnumerationSettingTypeBase.php

abstract class EnumerationSettingTypeBase in UI Patterns Settings 8.2

Base class for enumerations like radios or select.

Hierarchy

Expanded class hierarchy of EnumerationSettingTypeBase

4 files declare their use of EnumerationSettingTypeBase
ColorWidgetSettingType.php in src/Plugin/UiPatterns/SettingType/ColorWidgetSettingType.php
EnumerationSettingType.php in src/Plugin/UiPatterns/SettingType/EnumerationSettingType.php
RadiosSettingType.php in src/Plugin/UiPatterns/SettingType/RadiosSettingType.php
SelectSettingType.php in src/Plugin/UiPatterns/SettingType/SelectSettingType.php

File

src/Plugin/EnumerationSettingTypeBase.php, line 11

Namespace

Drupal\ui_patterns_settings\Plugin
View source 
abstract class EnumerationSettingTypeBase extends PatternSettingTypeBase {

  /**
   * Returns empty option.
   *
   * @return array
   *   The empty option.
   */
  protected function emptyOption() {
    return [
      "" => $this
        ->t("Please select"),
    ];
  }

  /**
   * Returns the enumeration type.
   *
   * @param \Drupal\ui_patterns_settings\Definition\PatternDefinitionSetting $def
   *   The pattern definition setting.
   *
   * @return string
   *   The enumeration type.
   */
  protected function getEnumerationType(PatternDefinitionSetting $def) {
    return $def
      ->getValue('enumeration_type');
  }

  /**
   * {@inheritdoc}
   */
  public function alterFieldStorage(FieldStorageConfig $storage_config) {
    $storage_config
      ->setSetting('allowed_values_function', 'ui_patterns_settings_allowed_values_function');
  }

  /**
   * {@inheritdoc}
   */
  public function fieldStorageExposableTypes() {
    return [
      'list_string',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, $value, PatternDefinitionSetting $def, $form_type) {
    if ($def
      ->getRequired() == FALSE) {
      $options = $this
        ->emptyOption();
    }
    else {
      $options = [];
    }
    $options += $def
      ->getOptions();
    $form[$def
      ->getName()] = [
      '#type' => $this
        ->getEnumerationType($def),
      '#title' => $def
        ->getLabel(),
      '#description' => $def
        ->getDescription(),
      '#default_value' => $this
        ->getValue($value),
      '#options' => $options,
    ];
    $this
      ->handleInput($form[$def
      ->getName()], $def, $form_type);
    return $form;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
EnumerationSettingTypeBase::alterFieldStorage public function Alter the storage of a connected field storage. Overrides PatternSettingTypeBase::alterFieldStorage
EnumerationSettingTypeBase::emptyOption protected function Returns empty option. 1
EnumerationSettingTypeBase::fieldStorageExposableTypes public function Returns the list to matching field types. Overrides PatternSettingTypeBase::fieldStorageExposableTypes
EnumerationSettingTypeBase::getEnumerationType protected function Returns the enumeration type. 3
EnumerationSettingTypeBase::settingsForm public function Returns the configuration form elements specific to this settings plugin.. Overrides PatternSettingTypeInterface::settingsForm
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PatternSettingTypeBase::$entityTypeManager protected property Return pattern definitions for setting .
PatternSettingTypeBase::$moduleHandler private property The module handler.
PatternSettingTypeBase::$patternDefinition private property Return pattern definitions for setting .
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 Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 1
PatternSettingTypeBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
PatternSettingTypeBase::formGroupProcess public static function Set the right group before drupal #group attribute is processed.
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::getSettingTypeDependencies protected function Returns a list of plugin dependencies. 2
PatternSettingTypeBase::getValue protected function Return value if set otherwise take the default value. 1
PatternSettingTypeBase::handleInput protected function Add validation and basics classes to the raw input field. 1
PatternSettingTypeBase::label public function
PatternSettingTypeBase::preprocess public function Returns the processed setting variable. Overrides PatternSettingTypeInterface::preprocess 1
PatternSettingTypeBase::preprocessExposedField public function Returns the processed setting variable for an exposed field. Overrides PatternSettingTypeInterface::preprocessExposedField 1
PatternSettingTypeBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
PatternSettingTypeBase::settingsPreprocess public function Preprocess setting variable. Overrides PatternSettingTypeInterface::settingsPreprocess 5
PatternSettingTypeBase::tokenForm protected function Returns the bind form field.
PatternSettingTypeBase::validateLayout public static function Check required input fields in layout forms.
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.