You are here

class BatchUserAction in Drupal 10

Same name and namespace in other branches
  1. 8 core/modules/views/tests/modules/user_batch_action_test/src/Plugin/Action/BatchUserAction.php \Drupal\user_batch_action_test\Plugin\Action\BatchUserAction
  2. 9 core/modules/views/tests/modules/user_batch_action_test/src/Plugin/Action/BatchUserAction.php \Drupal\user_batch_action_test\Plugin\Action\BatchUserAction

Provides action that sets batch precessing.

Plugin annotation


@Action(
  id = "user_batch_action_test_action",
  label = @Translation("Process user in batch"),
  type = "user",
)

Hierarchy

Expanded class hierarchy of BatchUserAction

File

core/modules/views/tests/modules/user_batch_action_test/src/Plugin/Action/BatchUserAction.php, line 18

Namespace

Drupal\user_batch_action_test\Plugin\Action
View source
class BatchUserAction extends ActionBase {

  /**
   * {@inheritdoc}
   */
  public function executeMultiple(array $entities) {
    $operations = [];
    foreach ($entities as $entity) {
      $operations[] = [
        [
          static::class,
          'processBatch',
        ],
        [
          [
            'entity_type' => $entity
              ->getEntityTypeId(),
            'entity_id' => $entity
              ->id(),
          ],
        ],
      ];
    }
    if ($operations) {
      $batch = [
        'operations' => $operations,
        'finished' => [
          static::class,
          'finishBatch',
        ],
      ];
      batch_set($batch);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function execute(ContentEntityInterface $entity = NULL) {
    $this
      ->executeMultiple([
      $entity,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {
    return TRUE;
  }

  /**
   * Processes the batch item.
   *
   * @param array $data
   *   Keyed array of data to process.
   * @param array $context
   *   The batch context.
   */
  public static function processBatch($data, &$context) {
    if (!isset($context['results']['processed'])) {
      $context['results']['processed'] = 0;
      $context['results']['theme'] = \Drupal::service('theme.manager')
        ->getActiveTheme(\Drupal::routeMatch())
        ->getName();
    }
    $context['results']['processed']++;
  }

  /**
   * Finish batch.
   *
   * @param bool $success
   *   Indicates whether the batch process was successful.
   * @param array $results
   *   Results information passed from the processing callback.
   */
  public static function finishBatch($success, $results) {
    \Drupal::messenger()
      ->addMessage(\Drupal::translation()
      ->formatPlural($results['processed'], 'One item has been processed.', '@count items have been processed.'));
    \Drupal::messenger()
      ->addMessage($results['theme'] . ' theme used');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BatchUserAction::access public function Checks object access. Overrides ActionInterface::access
BatchUserAction::execute public function Executes the plugin. Overrides ExecutableInterface::execute
BatchUserAction::executeMultiple public function Executes the plugin for an array of objects. Overrides ActionBase::executeMultiple
BatchUserAction::finishBatch public static function Finish batch.
BatchUserAction::processBatch public static function Processes the batch item.
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 18
MessengerTrait::messenger public function Gets the messenger. 18
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.
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
PluginBase::getDerivativeId public function
PluginBase::getPluginDefinition public function 2
PluginBase::getPluginId public function
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 53
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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. 1
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.