public function VariationXquantityStockAdjust::buildConfigurationForm in Commerce Extended Quantity 8

Form constructor.

Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and #array_parents, see \Drupal\Core\Render\Element\FormElement.

Parameters

array $form: An associative array containing the initial structure of the plugin form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form. Calling code should pass on a subform state created through \Drupal\Core\Form\SubformState::createForSubform().

Return value

array The form structure.

Overrides PluginFormInterface::buildConfigurationForm

File

modules/xquantity_stock/src/Plugin/Action/VariationXquantityStockAdjust.php, line 33

Class

VariationXquantityStockAdjust

Adjust variation stock.

Namespace

Drupal\xquantity_stock\Plugin\Action

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $request = \Drupal::request();
  $storage = \Drupal::service('entity_type.manager')
    ->getStorage('commerce_product_variation');
  if ($ids = explode('|', $request->query
    ->get('ids'))) {
    $variations = $storage
      ->loadMultiple($ids);
    $variation = reset($variations);
    $xquantity_stock = FALSE;
    foreach (array_reverse($variation
      ->getFieldDefinitions()) as $definition) {
      if ($definition
        ->getType() == 'xquantity_stock') {
        $xquantity_stock = $definition
          ->getName();
        $form_state
          ->set('xquantity_stock', $xquantity_stock);
        $settings = $variation
          ->get($xquantity_stock)
          ->getSettings();
        break;
      }
    }
    if (!$xquantity_stock) {
      $form['warning'] = [
        '#markup' => new TranslatableMarkup('<h1>To use this functionality you have to add the <span style="color:red">Xquantity Stock</span> field type to the current variation type.</h1>'),
      ];
    }
    else {
      $form_state
        ->set('variations', array_values($variations));
      $form['warning'] = [
        '#markup' => new TranslatableMarkup('<h1>Adjust Stock Quantity for <span style="color:red">@count</span> variations</h1><h3>The <em>Steps number</em> adjust type option will be cast to integer in case if the step property on a related order item <em>Quantity</em> field is decimal. Example: with the step <em>1.55</em> if you choose <em>3.1</em> for a number of steps then a stock for each variation will be increased / decreased by <em>1.55 X 3 = 4.65</em> value.<h3><mark>Note if the result of adjusting is a negative stock it will be converted to a <span style="color:red">0</span> stock.</mark>', [
          '@count' => count($variations),
        ]),
      ];
      $form['stock'] = [
        '#type' => 'container',
        '#attributes' => [
          'class' => [
            'container-inline',
          ],
        ],
      ];
      $form['stock']['adjust_op'] = [
        '#type' => 'select',
        '#options' => [
          'add' => $this
            ->t('Add'),
          'subtract' => $this
            ->t('Subtract'),
        ],
      ];
      $min = $settings['min'];
      $form['stock']['adjust_value'] = [
        '#type' => 'number',
        '#step' => !empty($settings['step']) ? $settings['step'] : pow(0.1, $settings['scale']),
        '#min' => (!is_numeric($min) || $min < 0) && $settings['unsigned'] ? '0' : $min,
      ];
      if (!empty($settings['default_value'])) {
        $form['stock']['adjust_value']['#default_value'] = $settings['default_value'];
      }
      $form['stock']['adjust_type'] = [
        '#type' => 'select',
        '#options' => [
          'fixed_number' => $this
            ->t('Fixed Number'),
          'steps_number' => $this
            ->t('Steps number'),
        ],
      ];
      $scale = Numeric::getDecimalDigits($form['stock']['adjust_value']['#step']);
      $form_state
        ->set('xquantity_stock_scale', $scale);
      $form_state
        ->set('xquantity_stock_step', $form['stock']['adjust_value']['#step']);
    }
    $form['cancel'] = [
      '#type' => 'submit',
      '#value' => 'CANCEL AND BACK',
      '#weight' => 1000,
    ];

    // Remove the "Action was applied to N items" message.
    \Drupal::messenger()
      ->deleteByType('status');
  }
  return $form;
}