PHPGangsta - Der praktische PHP Blog

Wer des öfteren Konsolenscripte in PHP schreibt kennt das Problem vielleicht: Das neue Admin-Script scheint wunderbar zu laufen, aber irgendwie möchte man den aktuellen Fortschritt beobachten können, denn solche Scripte laufen auch mal mehrere Minuten oder Stunden. Häufig gibt man dann bei jedem Schleifendurchlauf einen Punkt aus, sodass sich die Konsole mit Punkten füllt. Oder aber man gibt eine Laufvariable aus:

for ($i=0; $i<1000; $i++) {
    // Schleifeninhalt
    echo $i."\n";
}

Etwas professioneller sieht natürlich eine Progressbar aus, die die vergangene Zeit ausgibt, eine prozentuale Anzeige und die geschätzte Restzeit.

Das Zend Framework bietet dafür die Zend_Progressbar. Diese Komponente stellt mehrere Adapter bereit: Console, JsPush und JsPull. Hier zeige ich nur die Verwendung für die Konsole, das oben gezeigte Beispiel setzt man so um:

<?
$adapter = new Zend_ProgressBar_Adapter_Console();
$progressBar = new Zend_ProgressBar($adapter, 0, 1000);

for ($i=0; $i<1000; $i++) {
    // Schleifeninhalt
    $progressBar->update($i); // alternativ hier: $progressBar->next();
}

$progressBar->finish();

Der Konsolen-Adapter beherrscht aber noch mehr als diese einfache Ausgabe. Man kann die einzelnen Elemente (Balken, Prozentanzeige, Restzeit und Statustext) umpositionieren wie man es braucht, außerdem ist der Adapter in der Lage automatisch seinen aktuellen Fortschritt in einer Session zu speichern, sodass relativ einfach ein Neustart nach einem Abbruch möglich ist. Weitere Informationen befinden sich im Manual.

Nach kurzer Recherche findet man weitere fertige Scripte dafür, beispielsweise dieses von dealnews.com, Inc.:

<?
for($x=1; $x<=100; $x++){
    show_status($x, 100);
    usleep(100000);
}

function show_status($done, $total, $size=30) {

    static $start_time;

    // if we go over our bound, just ignore it
    if ($done > $total) return;

    if (empty($start_time)) {
        $start_time = time();
    }
    $now = time();

    $perc = (double)($done/$total);

    $bar = floor($perc*$size);

    $status_bar  = "\r[";
    $status_bar .= str_repeat("=", $bar);
    if ($bar<$size){
        $status_bar .= ">";
        $status_bar .= str_repeat(" ", $size-$bar);
    } else {
        $status_bar .= "=";
    }

    $disp = number_format($perc*100, 0);

    $status_bar .= "] $disp%  $done/$total";

    $rate = ($now-$start_time)/$done;
    $left = $total - $done;
    $eta = round($rate * $left, 2);

    $elapsed = $now - $start_time;

    $status_bar .= " remaining: ".number_format($eta)." sec.  elapsed: ".number_format($elapsed)." sec.";
    echo "$status_bar  ";

    flush();

    // when done, send a newline
    if($done == $total) {
        echo "\n";
    }
}

Weitere bekannte Vertreter sind die PEAR Console_ProgessBar und die eZ Components ezcConsoleProgressbar.