You are here

Home » API reference » Commerce Bulk 8 » BulkSkuWidget.php

class BulkSkuWidget in Commerce Bulk 8

Plugin implementation of the 'commerce_bulk_sku' widget.

Plugin annotation


@FieldWidget(
  id = "commerce_bulk_sku",
  label = @Translation("Commerce Bulk SKU"),
  field_types = {
    "string"
  }
)

Hierarchy

Expanded class hierarchy of BulkSkuWidget

File

src/Plugin/Field/FieldWidget/BulkSkuWidget.php, line 22

Namespace

Drupal\commerce_bulk\Plugin\Field\FieldWidget
View source 
class BulkSkuWidget extends StringTextfieldWidget {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'custom_label' => '',
      'uniqid_enabled' => TRUE,
      'more_entropy' => FALSE,
      'hide' => FALSE,
      'prefix' => 'sku-',
      'suffix' => '',
      'size' => 60,
      'placeholder' => '',
      'maximum' => 500,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $none = $this
      ->t('None');
    $settings = $this
      ->getSettings();
    $element['custom_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Custom label'),
      '#description' => $this
        ->t('The label for the SKU field displayed on a variation edit form.'),
      '#default_value' => empty($settings['custom_label']) ? '' : $settings['custom_label'],
      '#placeholder' => $none,
    ];
    $element['uniqid_enabled'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable unique auto SKU values generation'),
      '#default_value' => $settings['uniqid_enabled'],
    ];
    $element['more_entropy'] = [
      '#type' => 'checkbox',
      '#title_display' => 'before',
      '#title' => $this
        ->t('More unique'),
      '#description' => $this
        ->t('If unchecked the SKU (without prefix and suffix) will look like this: <strong>@short</strong>. If checked, like this: <strong>@long</strong>. <a href=":uniqid_href" target="_blank">Read more</a>', [
        ':uniqid_href' => 'http://php.net/manual/en/function.uniqid.php',
        '@short' => uniqid(),
        '@long' => uniqid('', TRUE),
      ]),
      '#default_value' => $settings['more_entropy'],
      '#states' => [
        'visible' => [
          ':input[name*="uniqid_enabled"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $element['hide'] = [
      '#type' => 'checkbox',
      '#title_display' => 'before',
      '#title' => $this
        ->t('Hide SKU'),
      '#description' => $this
        ->t('Hide the SKU field on a product add/edit forms adding SKU values silently at the background.'),
      '#default_value' => $settings['hide'],
      '#states' => [
        'visible' => [
          ':input[name*="uniqid_enabled"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $element['prefix'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('SKU prefix'),
      '#default_value' => $settings['prefix'],
      '#placeholder' => $none,
    ];
    $element['suffix'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('SKU suffix'),
      '#default_value' => $settings['suffix'],
      '#placeholder' => $none,
      '#description' => $this
        ->t('Note if you leave all the above settings empty some services will become unavailable. For example, bulk creation of variations will be disabled on a product add or edit form.'),
    ];
    $element['size'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Size of SKU field'),
      '#default_value' => $settings['size'],
      '#required' => TRUE,
      '#min' => 1,
    ];
    $element['placeholder'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Placeholder'),
      '#default_value' => $settings['placeholder'],
      '#description' => $this
        ->t('Text that will be shown inside the field until a value is entered. This hint is usually a sample value or a brief description of the expected format.'),
      '#placeholder' => $none,
    ];
    $element['maximum'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Maximum'),
      '#default_value' => $settings['maximum'],
      '#description' => $this
        ->t('The maximum of SKU values that might be generated in one go. Use it if you have troubles with bulk creation of variations on a product add or edit form. Helps to create a great number of variations by pressing <strong>Create N variations</strong> button several times. Note that <strong>the actual maximum of created values may differ</strong> as it depends on the number of attributes. Start from the minimum 3 SKU values to calculate the desired maximum.'),
      '#required' => TRUE,
      '#step' => 1,
      '#min' => 3,
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $none = $this
      ->t('None');
    $settings = $this
      ->getSettings();
    $sku = uniqid($settings['prefix'], $settings['more_entropy']) . $settings['suffix'];
    $settings['auto SKU sample'] = $settings['uniqid_enabled'] ? $sku : $none;
    $settings['hide'] = $settings['hide'] ? $this
      ->t('Yes') : $this
      ->t('No');
    unset($settings['uniqid_enabled'], $settings['more_entropy']);
    foreach ($settings as $name => $value) {
      $value = empty($settings[$name]) ? $none : $value;
      $summary[] = "{$name}: {$value}";
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $value = isset($items[$delta]->value) ? $items[$delta]->value : NULL;
    $settings = $this
      ->getSettings();
    $custom_label = $this
      ->getSetting('custom_label');
    $element['#title'] = !empty($custom_label) ? $custom_label : $element['#title'];
    $entity = $form_state
      ->getFormObject()
      ->getEntity();
    $variations = $variation = NULL;
    if ($entity instanceof BulkProductVariation) {
      $variation = $entity;
      $product = $variation
        ->getProduct();
      $variations = $product
        ->getVariations();
    }
    elseif ($entity instanceof Product) {
      $product = $entity;
      $variations = $product
        ->getVariations();
      $variation = end($variations);
    }
    if ($variation && !$variation
      ->id()) {
      $creator = \Drupal::service('commerce_bulk.variations_creator');
      $all = $creator
        ->getNotUsedAttributesCombination($variations ?: [
        $variation,
      ]);
      if ($price = $all['last_variation']
        ->getPrice()) {
        $form['price']['widget'][0]['#default_value'] = $price
          ->toArray();
      }
      if ($price = $all['last_variation']
        ->getListPrice()) {
        $form['list_price']['widget'][0]['has_value']['#default_value'] = TRUE;
        $form['list_price']['widget'][0]['value']['#default_value'] = $price
          ->toArray();
      }
      foreach ($all['attributes']['options'] as $attribute_name => $options) {
        if (isset($form[$attribute_name]['widget']['#options'])) {
          $form[$attribute_name]['widget']['#options'] = array_filter($form[$attribute_name]['widget']['#options'], function ($k) use ($options) {
            return $k == '_none' || isset($options[$k]);
          }, ARRAY_FILTER_USE_KEY);
        }
      }
      if ($all['not_used_combination']) {
        foreach ($all['not_used_combination'] as $attribute_name => $id) {
          if (isset($form[$attribute_name]['widget']['#default_value'])) {
            $form[$attribute_name]['widget']['#default_value'] = [
              $id,
            ];
          }
        }
      }
      $setup_link = $this
        ->t('<a href=":href" target="_blank">Set up default SKU.</a>', [
        ':href' => '/admin/commerce/config/product-variation-types/' . $variation
          ->bundle() . '/edit/form-display',
      ]);
      $element['#description'] = implode(' ', [
        $element['#description'],
        $setup_link,
      ]);
    }
    if (!empty($settings['uniqid_enabled']) && $settings['hide']) {
      $element['value']['#type'] = 'value';
      $element['value']['#value'] = $value;
    }
    else {
      $element['value'] = $element + [
        '#type' => 'textfield',
        '#default_value' => $value,
        '#size' => $this
          ->getSetting('size'),
        '#placeholder' => $this
          ->getSetting('placeholder'),
        '#maxlength' => $this
          ->getFieldSetting('max_length'),
        '#attributes' => [
          'class' => [
            'js-text-full',
            'text-full',
          ],
        ],
      ];
    }
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AllowedTagsXssTrait::allowedTags public function Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags public function Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss public function Filters an HTML string to prevent XSS vulnerabilities.
BulkSkuWidget::defaultSettings public static function Defines the default settings for this plugin. Overrides StringTextfieldWidget::defaultSettings
BulkSkuWidget::formElement public function Returns the form for a single field widget. Overrides StringTextfieldWidget::formElement
BulkSkuWidget::settingsForm public function Returns a form to configure settings for the widget. Overrides StringTextfieldWidget::settingsForm
BulkSkuWidget::settingsSummary public function Returns a short summary for the current widget settings. Overrides StringTextfieldWidget::settingsSummary
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.
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.
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. 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.
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::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement 8
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::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetInterface::massageFormValues 7
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