function FormatterHelper::formatBlock

Formats a message as a block of text.

File

vendor/symfony/console/Helper/FormatterHelper.php, line 34

Class

FormatterHelper

The Formatter class provides helpers to format messages.

Namespace

Symfony\Component\Console\Helper

Code

public function formatBlock(string|array $messages, string $style, bool $large = false) : string {
    if (!\is_array($messages)) {
        $messages = [
            $messages,
        ];
    }
    $len = 0;
    $lines = [];
    foreach ($messages as $message) {
        $message = OutputFormatter::escape($message);
        $lines[] = \sprintf($large ? '  %s  ' : ' %s ', $message);
        $len = max(self::width($message) + ($large ? 4 : 2), $len);
    }
    $messages = $large ? [
        str_repeat(' ', $len),
    ] : [];
    for ($i = 0; isset($lines[$i]); ++$i) {
        $messages[] = $lines[$i] . str_repeat(' ', $len - self::width($lines[$i]));
    }
    if ($large) {
        $messages[] = str_repeat(' ', $len);
    }
    for ($i = 0; isset($messages[$i]); ++$i) {
        $messages[$i] = \sprintf('<%s>%s</%s>', $style, $messages[$i], $style);
    }
    return implode("\n", $messages);
}