class VariationPriceAdjust in Commerce Bulk 8

Adjust variation price.

Plugin annotation


@Action(
  id = "commerce_bulk_variation_priceadjust",
  label = @Translation("Adjust price"),
  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\commerce_bulk\Plugin\Action\VariationPriceAdjust

Expanded class hierarchy of VariationPriceAdjust

File

src/Plugin/Action/VariationPriceAdjust.php, line 21

Namespace

Drupal\commerce_bulk\Plugin\Action

View source

class VariationPriceAdjust 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);
      $form_state
        ->set('variations', array_values($variations));
      $form['warning'] = [
        '#markup' => new TranslatableMarkup('<h1>Adjust Unit Price or List Price for <span style="color:red">@count</span> variations</h1><mark>Note if the result of adjusting is a negative price it will be converted to a <span style="color:red">0</span> price.</mark>', [
          '@count' => count($variations),
        ]),
      ];
      $form['price'] = [
        '#type' => 'container',
        '#attributes' => [
          'class' => [
            'container-inline',
          ],
        ],
      ];
      $form['price']['price_type'] = [
        '#type' => 'radios',
        '#options' => [
          'unit_price' => $this
            ->t('Unit Price'),
          'list_price' => $this
            ->t('List Price'),
        ],
        '#default_value' => 'unit_price',
      ];
      $form['price']['adjust_op'] = [
        '#type' => 'select',
        '#options' => [
          'add' => $this
            ->t('Add'),
          'subtract' => $this
            ->t('Subtract'),
        ],
      ];
      $form['price']['adjust_value'] = [
        '#type' => 'number',
        '#min' => '0.000001',
        '#step' => '0.000001',
      ];
      $form['price']['adjust_type'] = [
        '#type' => 'select',
        '#options' => [
          'fixed_number' => $this
            ->t('Fixed Number'),
          'percentage' => $this
            ->t('Percentage'),
        ],
      ];
      $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();
      if (!is_numeric($value = $values['adjust_value'])) {
        \Drupal::messenger()
          ->AddError($this
          ->t('The inserted adjust value is not numeric.'));
        return;
      }
      $set = $values['price_type'] == 'list_price' ? 'setListPrice' : 'setPrice';
      $get = $values['price_type'] == 'list_price' ? 'getListPrice' : 'getPrice';
      $op = $values['adjust_op'] == 'add' ? 'add' : 'subtract';
      foreach ($form_state
        ->get('variations') as $variation) {
        if (!($price = $variation
          ->{$get}())) {
          continue;
        }
        if ($values['adjust_type'] == 'fixed_number') {
          $adjust_price = new Price($value, $price
            ->getCurrencyCode());
        }
        else {
          $adjust_price = $price
            ->divide('100')
            ->multiply($value);
        }
        $price = $price
          ->{$op}($adjust_price);
        if ($price
          ->isNegative()) {
          $price = $price
            ->multiply('0');
        }
        $variation
          ->{$set}($price)
          ->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.
VariationPriceAdjust::access	public	function	Checks object access. Overrides ActionInterface::access
VariationPriceAdjust::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
VariationPriceAdjust::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableActionBase::defaultConfiguration
VariationPriceAdjust::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute
VariationPriceAdjust::executeMultiple	public	function	Executes the plugin for an array of objects. Overrides ActionBase::executeMultiple
VariationPriceAdjust::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm

You are here

class VariationPriceAdjust in Commerce Bulk 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation