StockTransactions2.php in Commerce Stock 8

Namespace

Drupal\commerce_stock_ui\Form

File

modules/ui/src/Form/StockTransactions2.php

<?php

namespace Drupal\commerce_stock_ui\Form;

use Drupal\commerce_product\ProductVariationStorage;
use Drupal\commerce_stock\StockServiceManager;
use Drupal\Core\Form\FormBase;
use Drupal\Core\Form\FormStateInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;

/**
 * The second part of a two part create stock transaction form.
 */
class StockTransactions2 extends FormBase {

  /**
   * The product variation storage.
   *
   * @var \Drupal\commerce_product\ProductVariationStorage
   */
  protected $productVariationStorage;

  /**
   * The stock service manager.
   *
   * @var \Drupal\commerce_stock\StockServiceManager
   */
  protected $stockServiceManager;

  /**
   * The current request.
   *
   * @var \Symfony\Component\HttpFoundation\Request
   */
  protected $request;

  /**
   * Constructs a StockTransactions2 object.
   *
   * @param \Drupal\commerce_product\ProductVariationStorage $productVariationStorage
   *   The commerce product variation storage.
   * @param \Drupal\commerce_stock\StockServiceManager $stockServiceManager
   *   The stock service manager.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   */
  public function __construct(ProductVariationStorage $productVariationStorage, StockServiceManager $stockServiceManager, Request $request) {
    $this->productVariationStorage = $productVariationStorage;
    $this->stockServiceManager = $stockServiceManager;
    $this->request = $request;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager')
      ->getStorage('commerce_product_variation'), $container
      ->get('commerce_stock.service_manager'), $container
      ->get('request_stack')
      ->getCurrentRequest());
  }

  /**
   * Returns the page title.
   */
  public function getTitle() {
    $variation_id = $this->request->query
      ->get('commerce_product_v_id');
    $product_variation = $this->productVariationStorage
      ->load($variation_id);
    return $this
      ->t('Create stock transaction for :product_variation', [
      ':product_variation' => $product_variation
        ->label(),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'commerce_stock_transactions2';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    if ($this->request->query
      ->has('commerce_product_v_id')) {
      $variation_id = $this->request->query
        ->get('commerce_product_v_id');
    }
    else {
      return $this
        ->redirect('commerce_stock_ui.stock_transactions1');
    }
    $product_variation = $this->productVariationStorage
      ->load($variation_id);
    $stockService = $this->stockServiceManager
      ->getService($product_variation);
    $locations = $stockService
      ->getStockChecker()
      ->getLocationList(TRUE);
    $location_options = [];

    /** @var \Drupal\commerce_stock\StockLocationInterface $location */
    foreach ($locations as $location) {
      $location_options[$location
        ->getId()] = $location
        ->getName();
    }
    $form['transaction_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Transaction type'),
      '#options' => [
        'receiveStock' => $this
          ->t('Receive stock'),
        'sellStock' => $this
          ->t('Sell stock'),
        'returnStock' => $this
          ->t('Return stock'),
        'moveStock' => $this
          ->t('Move stock'),
      ],
    ];
    $form['product_variation_id'] = [
      '#type' => 'value',
      '#value' => $variation_id,
    ];
    $form['source'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Source location'),
    ];
    $form['source']['source_location'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Location'),
      '#options' => $location_options,
    ];
    $form['source']['source_zone'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Zone/Bins'),
      '#description' => $this
        ->t('The location zone (bins)'),
      '#size' => 60,
      '#maxlength' => 50,
    ];
    $form['target'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Move target'),
      '#states' => [
        'visible' => [
          ':input[name="transaction_type"]' => [
            'value' => 'moveStock',
          ],
        ],
      ],
    ];
    $form['target']['target_location'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Target Location'),
      '#options' => $location_options,
    ];
    $form['target']['target_zone'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Zone/Bins'),
      '#description' => $this
        ->t('The location zone (bins)'),
      '#size' => 60,
      '#maxlength' => 50,
    ];
    $form['user'] = [
      '#type' => 'entity_autocomplete',
      '#title' => $this
        ->t('Optional user'),
      '#target_type' => 'user',
      '#selection_handler' => 'default',
      '#states' => [
        'visible' => [
          ':input[name="transaction_type"]' => [
            [
              'value' => 'sellStock',
            ],
            [
              'value' => 'returnStock',
            ],
          ],
        ],
      ],
    ];
    $form['order'] = [
      '#type' => 'entity_autocomplete',
      '#title' => $this
        ->t('Optional order number'),
      '#target_type' => 'commerce_order',
      '#selection_handler' => 'default',
      '#states' => [
        'visible' => [
          ':input[name="transaction_type"]' => [
            [
              'value' => 'sellStock',
            ],
            [
              'value' => 'returnStock',
            ],
          ],
        ],
      ],
    ];
    $form['transaction_qty'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Quantity'),
      '#default_value' => '1',
      '#step' => '0.01',
      '#required' => TRUE,
    ];
    $form['transaction_note'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Note'),
      '#description' => $this
        ->t('A note for the transaction'),
      '#maxlength' => 64,
      '#size' => 64,
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Submit'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   *
   * @todo: We need to check the product is managed by a stock service. Or
   * remove this override as it does nothing.
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $transaction_type = $form_state
      ->getValue('transaction_type');
    $product_variation_id = $form_state
      ->getValue('product_variation_id');
    $source_location = $form_state
      ->getValue('source_location');
    $source_zone = $form_state
      ->getValue('source_zone');
    $qty = $form_state
      ->getValue('transaction_qty');
    $transaction_note = $form_state
      ->getValue('transaction_note');
    $product_variation = $this->productVariationStorage
      ->load($product_variation_id);
    if ($transaction_type == 'receiveStock') {
      $this->stockServiceManager
        ->receiveStock($product_variation, $source_location, $source_zone, $qty, NULL, $currency_code = NULL, $transaction_note);
      $this
        ->messenger()
        ->addMessage($this
        ->t('@qty has been added to "@variation_title" using a "Received Stock" transaction.', [
        '@qty' => $qty,
        '@variation_title' => $product_variation
          ->getTitle(),
      ]));
    }
    elseif ($transaction_type == 'sellStock') {
      $order_id = $form_state
        ->getValue('order');
      $user_id = $form_state
        ->getValue('user');
      $this->stockServiceManager
        ->sellStock($product_variation, $source_location, $source_zone, $qty, NULL, $currency_code = NULL, $order_id, $user_id, $transaction_note);
      $this
        ->messenger()
        ->addMessage($this
        ->t('@qty has been removed from "@variation_title" using a "Sell Stock" transaction.', [
        '@qty' => $qty,
        '@variation_title' => $product_variation
          ->getTitle(),
      ]));
    }
    elseif ($transaction_type == 'returnStock') {
      $order_id = $form_state
        ->getValue('order');
      $user_id = $form_state
        ->getValue('user');
      $this->stockServiceManager
        ->returnStock($product_variation, $source_location, $source_zone, $qty, NULL, $currency_code = NULL, $order_id, $user_id, $transaction_note);
      $this
        ->messenger()
        ->addMessage($this
        ->t('@qty has been added to "@variation_title" using a "Return Stock" transaction.', [
        '@qty' => $qty,
        '@variation_title' => $product_variation
          ->getTitle(),
      ]));
    }
    elseif ($transaction_type == 'moveStock') {
      $target_location = $form_state
        ->getValue('target_location');
      $target_zone = $form_state
        ->getValue('target_zone');
      $this->stockServiceManager
        ->moveStock($product_variation, $source_location, $target_location, $source_zone, $target_zone, $qty, NULL, $currency_code = NULL, $transaction_note);

      // Display notification for end users.
      $target_location_entity = \Drupal::entityTypeManager()
        ->getStorage('commerce_stock_location')
        ->load($target_location);
      $target_location_name = $target_location_entity
        ->getName();
      $source_location_entity = \Drupal::entityTypeManager()
        ->getStorage('commerce_stock_location')
        ->load($source_location);
      $source_location_name = $source_location_entity
        ->getName();
      $this
        ->messenger()
        ->addMessage($this
        ->t('@qty has been moved from "@source_location" to "@target_location" for "@variation_title" using a "Move Stock" transaction.', [
        '@qty' => $qty,
        '@variation_title' => $product_variation
          ->getTitle(),
        '@source_location' => $source_location_name,
        '@target_location' => $target_location_name,
      ]));
    }
  }

}

Classes

Name	Description
StockTransactions2	The second part of a two part create stock transaction form.