interface BatchStorageInterface

Hierarchy

Expanded class hierarchy of BatchStorageInterface

All classes that implement BatchStorageInterface

File

drupal/core/lib/Drupal/Core/Utility/BatchStorageInterface.php, line 11
Definition of \Drupal\Core\Utility\BatchStorageInterface.

Namespace

Drupal\Core\Utility
View source
interface BatchStorageInterface {

  /**
   * Loads a batch.
   *
   * @param int $id
   *   The ID of the batch to load.
   *
   * @return array
   *   An array representing the batch, or FALSE if no batch was found.
   */
  public function load($id);

  /**
   * Creates and saves a batch.
   *
   * @param array $batch
   *   The array representing the batch to create.
   */
  public function create(array $batch);

  /**
   * Updates a batch.
   *
   * @param array $batch
   *   The array representing the batch to update.
   */
  public function update(array $batch);

  /**
   * Loads a batch.
   *
   * @param int $id
   *   The ID of the batch to delete.
   */
  public function delete($id);

  /**
   * Cleans up failed or old batches.
   */
  public function cleanup();

}

Members

Namesort descending Modifiers Type Description Overrides
BatchStorageInterface::cleanup public function Cleans up failed or old batches. 1
BatchStorageInterface::create public function Creates and saves a batch. 1
BatchStorageInterface::delete public function Loads a batch. 1
BatchStorageInterface::load public function Loads a batch. 1
BatchStorageInterface::update public function Updates a batch. 1