Overwriting Terminal Output PHP

overwriting-terminal-output.md

/**
 * Print a text and overwrite it (on the output) on a next call (terminal use only).
 *
 * @param  string $text
 * @return void
 */
function print_overwriting(string $text): void
{
    static $isFirstCall = true;

    // Ensure that the last char is a line break.
    $textLastChars = substr($text, -strlen(PHP_EOL));
    $text = $textLastChars != PHP_EOL ? $text . PHP_EOL : $text;

    if ($isFirstCall) {
        print $text;
    } else {
        $textLines = count(explode(PHP_EOL, $text)) - 1;

        // print "\x0D"; // Move the cursor to the beginning of the line (same as "\r").
        // print "\x1B[2K"; // Erase the line.
        // print str_repeat("\x1B[1A\x1B[2K", $textLines); // Erase previous lines.
        // print $text;

        // One line approach.
        print "\x0D\x1B[2K" . str_repeat("\x1B[1A\x1B[2K", $textLines) . $text;
    }

    if ($isFirstCall) $isFirstCall = false;
}

$count = 1000;

for ($i = 1; $i <= $count; $i++) {
    $firstRun = $i == 100;

    if ($i % 100 == 0) {
        sleep(1);

        $text = "Count: {$count}" . PHP_EOL .
                  "Index: {$i}" . PHP_EOL .
                  "Index: {$i}" . PHP_EOL .
                  "Index: {$i}" . PHP_EOL .
                  "Index: {$i}" . PHP_EOL;
                  // You can add a number of lines as you want.

        print_overwriting($text);
    }
}