You are here

Home » API reference » Commerce Bulk 8 » VariationHook.php

class VariationHook in Commerce Bulk 8

Pass variation to a hook.

Plugin annotation


@Action(
  id = "commerce_bulk_variation_hook",
  label = @Translation("Pass to hook"),
  type = "commerce_product_variation"
)

Hierarchy

Expanded class hierarchy of VariationHook

File

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

Namespace

Drupal\commerce_bulk\Plugin\Action
View source 
class VariationHook extends ConfigurableActionBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $request = \Drupal::request();
    if ($ids = explode('|', $request->query
      ->get('ids'))) {
      $storage = \Drupal::service('entity_type.manager')
        ->getStorage('commerce_product_variation');
      $variations = $storage
        ->loadMultiple($ids);
      $variation = reset($variations);
      $product = $variation
        ->getProduct();
      $readmehelp = readmehelp_converter_service();
      $path = $readmehelp->moduleHandler
        ->getModuleDirectories()['commerce_bulk'] . '/commerce_bulk.module';
      $form_state
        ->set('kit', [
        'variations' => $variations,
        'product' => $product,
        'product_type' => $product
          ->bundle(),
      ]);
      $form['warning'] = [
        '#markup' => new TranslatableMarkup('<h1>Add custom data</h1><h3>You are about to invoke the <mark>hook_commerce_bulk_variation_alter()</mark> on <span style="color:red;font-weight:bolder;">@count</span> variations.</h3><h3>See example hook implementation in the commerce_bulk.module file:</h3><div style="border:1px solid grey">' . $readmehelp
          ->highlightPhp($path, 18, 12) . '</div>', [
          '@count' => count($variations),
        ]),
      ];
      $form['data'] = [
        '#type' => 'textarea',
        '#title' => $this
          ->t('Optional JSON or XML data'),
        '#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') {
      $kit = $form_state
        ->get('kit');
      \Drupal::moduleHandler()
        ->alter('commerce_bulk_variation', $kit['variations'], $form_state
        ->getValue('data'), $kit['product_type']);
      $kit['variations'] = $kit['product']
        ->getVariations();
      $kit['product']
        ->setVariations($kit['variations']);
      $kit['product']
        ->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('delete', $account, TRUE);
    return $return_as_object ? $result : $result
      ->isAllowed();
  }

}

Members

Namesort descending 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.
VariationHook::access public function Checks object access. Overrides ActionInterface::access
VariationHook::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
VariationHook::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableActionBase::defaultConfiguration
VariationHook::execute public function Executes the plugin. Overrides ExecutableInterface::execute
VariationHook::executeMultiple public function Executes the plugin for an array of objects. Overrides ActionBase::executeMultiple
VariationHook::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm