class BatchUserAction
Same name in other branches
- 9 core/modules/views/tests/modules/user_batch_action_test/src/Plugin/Action/BatchUserAction.php \Drupal\user_batch_action_test\Plugin\Action\BatchUserAction
- 8.9.x core/modules/views/tests/modules/user_batch_action_test/src/Plugin/Action/BatchUserAction.php \Drupal\user_batch_action_test\Plugin\Action\BatchUserAction
- 10 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.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Action\ActionBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Action\ActionInterface
- class \Drupal\user_batch_action_test\Plugin\Action\BatchUserAction extends \Drupal\Core\Action\ActionBase
- class \Drupal\Core\Action\ActionBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Action\ActionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of BatchUserAction
File
-
core/
modules/ views/ tests/ modules/ user_batch_action_test/ src/ Plugin/ Action/ BatchUserAction.php, line 16
Namespace
Drupal\user_batch_action_test\Plugin\ActionView 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($entity = NULL) {
assert($entity instanceof ContentEntityInterface);
$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
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | 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. | ||
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 7 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 3 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.