You are here

Home » API reference » Unlimited Number Field 2.x » UnlimitedNumberWidget.php

class UnlimitedNumberWidget in Unlimited Number Field 2.x

Same name and namespace in other branches
  1. 8 src/Plugin/Field/FieldWidget/UnlimitedNumberWidget.php \Drupal\unlimited_number\Plugin\Field\FieldWidget\UnlimitedNumberWidget

Plugin implementation of the 'unlimited_number' widget.

Plugin annotation


@FieldWidget(
  id = "unlimited_number",
  label = @Translation("Unlimited or Number"),
  field_types = {
    "integer",
  }
)

Hierarchy

Expanded class hierarchy of UnlimitedNumberWidget

File

src/Plugin/Field/FieldWidget/UnlimitedNumberWidget.php, line 21

Namespace

Drupal\unlimited_number\Plugin\Field\FieldWidget
View source 
class UnlimitedNumberWidget extends NumberWidget {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'value_unlimited' => 0,
      'label_unlimited' => t('Unlimited'),
      'label_number' => t('Limited'),
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = parent::settingsForm($form, $form_state);
    $element['value_unlimited'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Unlimited value'),
      '#default_value' => $this
        ->getSetting('value_unlimited'),
      '#description' => $this
        ->t('Internal number to use for unlimited.'),
    ];
    $element['label_unlimited'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Unlimited Label'),
      '#default_value' => $this
        ->getSetting('label_unlimited'),
      '#description' => $this
        ->t('Text that will be used for the unlimited radio.'),
    ];
    $element['label_number'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Number Label'),
      '#default_value' => $this
        ->getSetting('label_number'),
      '#description' => $this
        ->t('Text that will be used for the number radio.'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $field_settings = $this
      ->getFieldSettings();
    $value_unlimited = $this
      ->getUnlimitedValue();
    $value = isset($items[$delta]->value) ? $items[$delta]->value : NULL;
    if (isset($value)) {
      $default_value = $value == $value_unlimited ? UnlimitedNumber::UNLIMITED : $value;
    }
    else {
      $default_value = NULL;
    }
    $form_element['unlimited_number'] = $element + [
      '#type' => 'unlimited_number',
      '#default_value' => $default_value,
      '#min' => is_numeric($field_settings['min']) ? $field_settings['min'] : 1,
      '#max' => is_numeric($field_settings['max']) ? $field_settings['max'] : NULL,
      '#options' => [
        'unlimited' => $this
          ->getSetting('label_unlimited'),
        'limited' => $this
          ->getSetting('label_number'),
      ],
      '#parents' => [
        $items
          ->getName(),
        $delta,
        'unlimited_number',
      ],
    ];
    return $form_element;
  }

  /**
   * {@inheritdoc}
   */
  public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
    $new_values = [];
    foreach ($values as $value) {
      $number = $value['unlimited_number'];
      if ($value['unlimited_number'] == UnlimitedNumber::UNLIMITED) {
        $number = $this
          ->getUnlimitedValue();
      }
      $new_values[]['value'] = $number;
    }
    return $new_values;
  }

  /**
   * Get unlimited value from settings.
   *
   * @return integer
   */
  public function getUnlimitedValue() {
    $value_unlimited_raw = $this
      ->getSetting('value_unlimited');
    return empty($value_unlimited_raw) ? 0 : $value_unlimited_raw;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
NumberWidget::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetBase::errorElement
NumberWidget::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
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 2
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.
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
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.
UnlimitedNumberWidget::defaultSettings public static function Defines the default settings for this plugin. Overrides NumberWidget::defaultSettings
UnlimitedNumberWidget::formElement public function Returns the form for a single field widget. Overrides NumberWidget::formElement
UnlimitedNumberWidget::getUnlimitedValue public function Get unlimited value from settings.
UnlimitedNumberWidget::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetBase::massageFormValues
UnlimitedNumberWidget::settingsForm public function Returns a form to configure settings for the widget. Overrides NumberWidget::settingsForm
WidgetBase::$fieldDefinition protected property The field definition.
WidgetBase::$settings protected property The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax public static function Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit public static function Submission handler for the "Add another item" button.
WidgetBase::afterBuild public static function After-build handler for field elements in a form.
WidgetBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 5
WidgetBase::extractFormValues public function Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues 2
WidgetBase::flagErrors public function Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors 2
WidgetBase::form public function Creates a form element for a field. Overrides WidgetBaseInterface::form 3
WidgetBase::formMultipleElements protected function Special handling to create form elements for multiple values. 1
WidgetBase::formSingleElement protected function Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting protected function Returns the value of a field setting.
WidgetBase::getFieldSettings protected function Returns the array of field settings.
WidgetBase::getFilteredDescription protected function Returns the filtered field description.
WidgetBase::getWidgetState public static function Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents protected static function Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues protected function Returns whether the widget handles multiple values.
WidgetBase::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable 4
WidgetBase::isDefaultValueWidget protected function Returns whether the widget used for default value form.
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState
WidgetBase::__construct public function Constructs a WidgetBase object. Overrides PluginBase::__construct 5