Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. ConsoleSectionOutput.php

function ConsoleSectionOutput::doWrite

Overrides StreamOutput::doWrite

File

vendor/symfony/console/Output/ConsoleSectionOutput.php, line 161

Class

ConsoleSectionOutput
@author Pierre du Plessis <pdples@gmail.com> @author Gabriel Ostrolucký <gabriel.ostrolucky@gmail.com>

Namespace

Symfony\Component\Console\Output

Code

protected function doWrite(string $message, bool $newline) : void {
    // Simulate newline behavior for consistent output formatting, avoiding extra logic
    if (!$newline && str_ends_with($message, \PHP_EOL)) {
        $message = substr($message, 0, -\strlen(\PHP_EOL));
        $newline = true;
    }
    if (!$this->isDecorated()) {
        parent::doWrite($message, $newline);
        return;
    }
    // Check if the previous line (last entry of `$this->content`) needs to be continued
    // (i.e. does not end with a line break). In which case, it needs to be erased first.
    $linesToClear = $deleteLastLine = ($lastLine = end($this->content) ?: '') && !str_ends_with($lastLine, \PHP_EOL) ? 1 : 0;
    $linesAdded = $this->addContent($message, $newline);
    if ($lineOverflow = $this->maxHeight > 0 && $this->lines > $this->maxHeight) {
        // on overflow, clear the whole section and redraw again (to remove the first lines)
        $linesToClear = $this->maxHeight;
    }
    $erasedContent = $this->popStreamContentUntilCurrentSection($linesToClear);
    if ($lineOverflow) {
        // redraw existing lines of the section
        $previousLinesOfSection = \array_slice($this->content, $this->lines - $this->maxHeight, $this->maxHeight - $linesAdded);
        parent::doWrite(implode('', $previousLinesOfSection), false);
    }
    // if the last line was removed, re-print its content together with the new content.
    // otherwise, just print the new content.
    parent::doWrite($deleteLastLine ? $lastLine . $message : $message, true);
    parent::doWrite($erasedContent, false);
}

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal