class VariationSKU in Commerce Bulk 8

Duplicate variation.

Plugin annotation


@Action(
  id = "commerce_bulk_variation_sku",
  label = @Translation("Change SKUs"),
  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\VariationSKU

Expanded class hierarchy of VariationSKU

File

src/Plugin/Action/VariationSKU.php, line 20

Namespace

Drupal\commerce_bulk\Plugin\Action

View source

class VariationSKU 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'))) {
      $readmehelp = readmehelp_converter_service();
      $path = $readmehelp->moduleHandler
        ->getModuleDirectories()['commerce_bulk'] . '/commerce_bulk.module';
      $variations = $storage
        ->loadMultiple($ids);
      $form_state
        ->set('variations', array_values($variations));
      $skus = '';
      foreach ($variations as $variation) {
        $skus .= $variation
          ->getSku() . PHP_EOL;
      }
      $form['warning'] = [
        '#markup' => new TranslatableMarkup('<h1>Note that each SKU must be <span style="color:red">unique</span> accross all SKUs existing on the current Drupal Commerce site and not exceed <span style="color:red">60</span> characters length.</h1><h3><mark>Tip:</mark> SKU for each variation can also be programmatically set in the <mark>hook_bulk_creator_sku_alter()</mark> for your needs while executing <mark>Duplicate variation</mark> action. See example hook implementation in the commerce_bulk.module file:</h3><div style="border:1px solid grey">' . $readmehelp
          ->highlightPhp($path, 41, 6) . '</div>'),
      ];
      $form['skus'] = [
        '#type' => 'textarea',
        '#title' => $this
          ->t('SKUs'),
        '#default_value' => $skus,
        '#rows' => 20,
      ];
      $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') {
      $storage = \Drupal::service('entity_type.manager')
        ->getStorage('commerce_product_variation');
      $skus = explode(PHP_EOL, trim($form_state
        ->getValue('skus')));
      $list = '';
      foreach ($form_state
        ->get('variations') as $index => $variation) {
        $sku = isset($skus[$index]) ? trim($skus[$index]) : FALSE;
        if ($sku && strlen($sku) < 61 && !$storage
          ->loadBySku($sku)) {
          $variation
            ->setSku($sku)
            ->save();
        }
        else {
          $list .= "<li>{$sku}</li>";
        }
      }
      if ($list) {
        \Drupal::messenger()
          ->addWarning(new TranslatableMarkup("<h3>The following SKUs were rejected as they already exist or more than 60 characters:</h3><ul>{$list}</ul>"));
      }
    }
  }

  /**
   * {@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('delete', $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.
VariationSKU::access	public	function	Checks object access. Overrides ActionInterface::access
VariationSKU::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
VariationSKU::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableActionBase::defaultConfiguration
VariationSKU::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute
VariationSKU::executeMultiple	public	function	Executes the plugin for an array of objects. Overrides ActionBase::executeMultiple
VariationSKU::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm

You are here

class VariationSKU in Commerce Bulk 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation