Batch-API in Drupal

Bild des Benutzers tobiasb
tobiasb geändert am Sonntag, 17 Juli, 2011 - 13:32

Falls wer noch nicht weiß wofür man die Batch-API nutzen kann, hier der Versuch zur Erklärung. Mit der Batch-API kann man Aufgaben erledigen, die nicht in einem Request, also einem Seitenaufruf durchgeführt wird, sondern in mehrere aufgeteilt wird.

Welchen Sinn macht das?

Durch diese Aufteilung kann verhindern werden, dass das Abarbeiten der Aufgaben in einem Abbruch seitens des Servers führt, weil die maximale Scriptlaufzeit überschritten wurde. Standardmäßig 30 Sekunden. Oder auch der PHP-Speicher droht überzulaufen und dann abbricht.

Es gibt 3 mir bekannte Anwendungsfälle, wie man diese Batch-Api nutzen kann.

  1. Durch das Ausführen eines Formulars
  2. Durch manuelles aufrufen einer URL bsp. Ausführen des Crons (Klick im Statusbericht auf "manuell durchgeführt" oder cron.php)
  3. Durch maschinelles aufrufen einer URL bsp. Ausführen des Crons (crontab - Server triggert den Cron)

Im 1. Anwendungsfall überprüft Drupal selbst in der Form-Api, ob ein Batch gestartet wurde und zeigt die bekannte UI für Batch-Vorgänge an.

Im 2. Anwendungsfall muss man nur die Funktion batch_process(); aufrufen, die Drupal sonst in der Form-API aufruft.

Im 3. Anwendungsfall muss man Drupal mitteilen, das der Batch-Vorgang nicht im Browser stattfindet und das erledigt mit der Option $batch['progressive'] = FALSE;. Dann wie gehabt Batch-Vorgang anstossen.

Das in einer Funktion gepackt, könnte es so aussehen:

  1. <?php
  2. function mymodule_run_batch($form = TRUE) {
  3.   $operations = mymodule_build_batch();
  4.   if (!empty($operations)) {
  5.     $batch = array(
  6.       'operations'    => $operations,
  7.       'title'         => 'Irgendwas',
  8.       'init_message'  => 'Beginne',
  9.       'error_message' => 'Fehler beim Ausführen',
  10.       'file'          => __FILE__,
  11.     );
  12.     batch_set($batch);
  13.     if (ip_address() == '127.0.0.1') {
  14.       //cron from local maschine
  15.       $batch =& batch_get();
  16.       $batch['progressive'] = FALSE;
  17.       batch_process();
  18.     }
  19.     elseif (!$form) {
  20.       //cron by hand
  21.       batch_process();
  22.     }
  23.     return TRUE;
  24.   }
  25.   else{
  26.     return FALSE;
  27.   }
  28. }
  29. ?>

Beim Aufruf dieser Funktion außerhalb eines Submit-Handlers, muss man dann einfach den Parameter FALSE übergeben.