function BatchStorage::delete

Same name in this branch
  1. 10 core/lib/Drupal/Core/ProxyClass/Batch/BatchStorage.php \Drupal\Core\ProxyClass\Batch\BatchStorage::delete()
Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/ProxyClass/Batch/BatchStorage.php \Drupal\Core\ProxyClass\Batch\BatchStorage::delete()
  2. 9 core/lib/Drupal/Core/Batch/BatchStorage.php \Drupal\Core\Batch\BatchStorage::delete()
  3. 8.9.x core/lib/Drupal/Core/ProxyClass/Batch/BatchStorage.php \Drupal\Core\ProxyClass\Batch\BatchStorage::delete()
  4. 8.9.x core/lib/Drupal/Core/Batch/BatchStorage.php \Drupal\Core\Batch\BatchStorage::delete()
  5. 11.x core/lib/Drupal/Core/ProxyClass/Batch/BatchStorage.php \Drupal\Core\ProxyClass\Batch\BatchStorage::delete()
  6. 11.x core/lib/Drupal/Core/Batch/BatchStorage.php \Drupal\Core\Batch\BatchStorage::delete()

Deletes a batch.

Parameters

int $id: The ID of the batch to delete.

Overrides BatchStorageInterface::delete

File

core/lib/Drupal/Core/Batch/BatchStorage.php, line 92

Class

BatchStorage

Namespace

Drupal\Core\Batch

Code

public function delete($id) {
  try {
    $this->connection
      ->delete('batch')
      ->condition('bid', $id)
      ->execute();
  } catch (\Exception $e) {
    $this->catchException($e);
  }
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.