class VariationXquantityStockAdjust in Commerce Extended Quantity 8

Adjust variation stock.

Plugin annotation


@Action(
  id = "variation_xquantity_stock_adjust",
  label = @Translation("Adjust stock"),
  type = "commerce_product_variation"
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Action\ActionBase implements ActionInterface
    class \Drupal\Core\Action\ConfigurableActionBase implements ConfigurableInterface, ConfigurablePluginInterface, DependentPluginInterface, PluginFormInterface
    class \Drupal\xquantity_stock\Plugin\Action\VariationXquantityStockAdjust

Expanded class hierarchy of VariationXquantityStockAdjust

File

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

Namespace

Drupal\xquantity_stock\Plugin\Action

View source

class VariationXquantityStockAdjust extends ConfigurableActionBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  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;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->getTriggeringElement()['#id'] != 'edit-cancel') {
      $values = $form_state
        ->getValues();
      $xquantity_stock = $form_state
        ->get('xquantity_stock');
      if (empty($xquantity_stock) || !is_numeric($value = $values['adjust_value'])) {
        \Drupal::messenger()
          ->AddError($this
          ->t('The inserted adjust value is not numeric.'));
        return;
      }
      $op = $values['adjust_op'] == 'add' ? 'bcadd' : 'bcsub';
      $scale = $form_state
        ->get('xquantity_stock_scale');
      $step = $form_state
        ->get('xquantity_stock_step');
      foreach ($form_state
        ->get('variations') as $variation) {
        $stock = $variation
          ->get($xquantity_stock)->value;
        if ($values['adjust_type'] == 'fixed_number') {
          $quantity = $op($stock, $value, $scale);
        }
        else {
          $quantity = $op($stock, bcmul($step, (int) $value, $scale), $scale);
        }
        $quantity = bccomp($quantity, '0', $scale) === 1 ? $quantity : '0';
        $variation
          ->set($xquantity_stock, $quantity)
          ->save();
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function executeMultiple(array $variations) {
    if ($variations) {
      $ids = [];
      foreach ($variations as $variation) {
        $ids[] = $variation
          ->id();
      }
      $url = $variation
        ->toUrl();
      $query = [
        'destination' => \Drupal::request()
          ->getRequestUri(),
        'ids' => implode('|', $ids),
      ];
      $path = $url::fromUserInput('/admin/config/system/actions/configure/' . $this
        ->getPluginId(), [
        'query' => $query,
      ])
        ->toString();
      $response = new RedirectResponse($path);
      $response
        ->send();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function execute($variation = NULL) {

    // Do nothing.
  }

  /**
   * {@inheritdoc}
   */
  public function access($variation, AccountInterface $account = NULL, $return_as_object = FALSE) {
    $result = $variation
      ->access('update', $account, TRUE);
    return $return_as_object ? $result : $result
      ->isAllowed();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableActionBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	1
ConfigurableActionBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConfigurableActionBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ConfigurableActionBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm	2
ConfigurableActionBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	6
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.
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.
VariationXquantityStockAdjust::access	public	function	Checks object access. Overrides ActionInterface::access
VariationXquantityStockAdjust::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
VariationXquantityStockAdjust::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableActionBase::defaultConfiguration
VariationXquantityStockAdjust::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute
VariationXquantityStockAdjust::executeMultiple	public	function	Executes the plugin for an array of objects. Overrides ActionBase::executeMultiple
VariationXquantityStockAdjust::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm

You are here

class VariationXquantityStockAdjust in Commerce Extended Quantity 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation